swagger.yaml

---
components:
  parameters:
    dbidQuery:
      description: |
        Unique constituent database identifier from the `ndb.constituentdatabases` table. Each of the Neotoma constituent databases is identified uniquely with an integer primary key.
      in: query
      name: dbid
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 35
    ageQuery:
      description: |
        Icesheet age (in calibrated radiocarbon years before present, with 0 at 1950CE). Ages range from 0 to 18000.
      in: query
      name: age
      required: false
      schema:
        example: 6700
        format: int64
        maximum: 18000
        minimum: 1000
        type: integer
    ageOfQuery:
      description: Dataset age ranges must span this age (in calibrated years before present, with 0 at 1950CE)
      in: query
      name: ageof
      required: false
      schema:
        example: 6700
        format: int64
        maximum: 23900000
        minimum: -100
        type: integer
    scinameQuery:
      description: The scientific name for a mammal taxon. May be the complete name or use the `%` wildcard for the name.
      in: query
      name: sciname
      required: true
      schema:
        example: canis%
        type: string
    projQuery:
      in: query
      name: proj
      required: false
      schema:
        type: integer
        minimum: 2000
        maximum: 32767
        default: 4326
        example: 3857
      description: |
        A valid integer [spatial reference identifier](https://en.wikipedia.org/wiki/Spatial_reference_system#Identifier) value. By default Neotoma returns all data with the SRID 4326 (standard lat/long), representing the [WSG84](https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84) model of the planet. For web mapping users may choose SRID *3857* if using projected features.
    precQuery:
      description: |
        Precision of points within a rendered polygon. Many spatial objects are generated statistically and may have overly precise point coordinates. Often precisions to 100m is sufficient for rendering to map.<br>
        **NOTE**: the precision is dependent on the projected units. For the default SRID=4326 projection, precision units are in decimal degrees, where 0.1 degrees latitude = 11.1km and 0.0001 degrees latitude = 11.1m. For metric precision, units will be in meters.<br>
        The default value of *0.0001* represents a metric distance of 11.1m in the default 4326 projection.
      in: query
      name: prec
      required: false
      schema:
        example: 100
        minimum: 0
        maximum: 1000
        exclusiveMinimum: true
        type: number
        default: 0.0001
    ageOldQuery:
      description: Oldest age that intercepts with the dataset (in calibrated years before present, with 0 at 1950CE)
      in: query
      name: ageold
      required: false
      schema:
        example: 11430
        format: int64
        maximum: 23900000
        minimum: -100
        type: integer
    ageYoungQuery:
      description: Youngest age that intercepts with the dataset (in calibrated years before present, with 0 at 1950CE)
      in: query
      name: ageyoung
      required: false
      schema:
        example: -60
        format: int64
        maximum: 23900000
        minimum: -100
        type: integer
    altMaxQuery:
      description: Maximum altitude of the dataset site location (in meters)
      in: query
      name: altmax
      required: false
      schema:
        example: 300
        format: int64
        maximum: 8900
        minimum: -500
        type: integer
    altMinQuery:
      description: Minimum altitude of the dataset site location (in meters)
      in: query
      name: altmin
      required: false
      schema:
        example: 200
        format: int64
        maximum: 8900
        minimum: -500
        type: integer
    chronidPath:
      description: Unique chronology identifier.
      in: path
      name: chronid
      required: true
      schema:
        format: int64
        maximum: 40000
        minimum: 0
        exclusiveMinimum: true
        type: integer
    contactNameQuery:
      description: Last name of the researcher (may use the % wildcard)
      in: query
      name: contactname
      required: false
      schema:
        example: Grimm, Eric Christopher
        type: string
    countQuery:
      description: Should we return the row count for the table?
      in: query
      name: count
      required: false
      schema:
        type: boolean
        default: false
    contactStatusQuery:
      description: Current employment status
      in: query
      name: contactstatus
      required: false
      schema:
        enum:
          - active
          - deceased
          - defunct
          - extant
          - inactive
          - retired
          - unknown
        example: active
        type: string
    contactidPath:
      description: Unique contact identifier within the Neotoma Database, alone or comma separated.
      in: path
      name: contactid
      required: true
      schema:
        example: 44
        format: int64
        maximum: 20000
        minimum: 1
        type: integer
    contactidQuery:
      description: Unique contact identifier within the Neotoma Database, alone or comma separated.
      in: query
      name: contactid
      required: false
      schema:
        example: 44
        format: int64
        maximum: 20000
        minimum: 1
        type: integer
    databaseQuery:
      description: One of the constituent databases within Neotoma
      in: query
      name: database
      required: true
      schema:
        enum:
          - Cooperative Holocene Mapping Project
          - African Pollen Database
          - European Pollen Database
          - Indo-Pacific Pollen Database
          - Latin American Pollen Database
          - North American Pollen Database
          - Pollen Database of Siberia and the Russian Far East
          - Canadian Pollen Database
          - FAUNMAP
          - Neotoma
          - North American Plant Macrofossil Database
          - Academy of Natural Sciences of Drexel University
          - NDSU Insect Database
          - North American Non-Marine Ostracode Database Project (NANODe)
          - MioMap
          - Alaskan Archaeofaunas
          - French Institute of Pondicherry Palynology and Paleoecology Database
          - Japanese Pollen Database
          - Neotoma Midden Database
          - Chinese Pollen Database
          - Holocene Perspective on Peatland Biogeochemistry
          - ANTIGUA
          - Neotoma Testate Amoebae Database
          - Deep-Time Palynology Database
          - Neotoma Biomarker Database
          - Alpine Pollen Database
          - Canadian Museum of Nature-Delorme Ostracoda-Surface Samples
          - Diatom Paleolimnology Data Cooperative (DPDC)
          - Neotoma Ostracode Database
          - Faunal Isotope Database
          - Neotoma Charcoal Data
          - Pollen Monitoring Programme
          - PaleoVertebrates of Latin America
          - St. Croix Watershed Research Station of the Science Museum of Minnesota
        type: string
    datasetidPath:
      description: Valid Neotoma dataset identifier (integer), either singly or in a comma separated list.
      in: path
      name: datasetid
      required: true
      schema:
        example: 100
        format: int32
        maximum: 60000
        minimum: 1
        type: integer
    datasetidQuery:
      description: Valid Neotoma dataset identifier (integer), either singly or in a comma separated list.
      in: query
      name: datasetid
      required: false
      schema:
        format: int32
        minimum: 0
        exclusiveMinimum: true
        type: integer
    doiQuery:
      description: A valid DOI in the form 10.XXXX/XXXXX (i.e., excluding 'https://doi.org').
      in: query
      name: doi
      required: false
      schema:
        type: string
        pattern: ^10.\d{4,9}/[-._;()/:A-Z0-9]+$
        example: 10.21233/J8P9-G487
    datasettypeQuery:
      description: Neotoma contains data for a number of dataset types (see /dbtables/datasettypes.  This returns a subset of data types.
      in: query
      name: datasettype
      required: false
      schema:
        type: string
        nullable: true
        enum:
          - geochronologic
          - loss-on-ignition
          - pollen
          - plant macrofossil
          - vertebrate fauna
          - macroinvertebrate
          - pollen surface sample
          - insect
          - ostracode
          - water chemistry
          - diatom
          - ostracode surface sample
          - diatom surface sample
          - geochemistry
          - physical sedimentology
          - charcoal
          - testate amoebae
          - X-ray fluorescence (XRF)
          - X-ray diffraction (XRD)
          - energy dispersive X-ray spectroscopy (EDS/EDX)
          - biomarker
          - modern plant biomarker
          - phytolith
          - specimen stable isotope
          - paleomagnetic,biochemistry
          - modern biochemistry
          - organic carbon
          - insect modern
          - chironomid
          - stable isotope
          - testate amoebae surface sample
          - charcoal surface sample
          - cladocera
          - diatom top-bottom
          - microcharcoal
          - macrocharcoal
          - pollen trap
          - dinoflagellates
          - diatom bottom sample
          - Metabarcoding aeDNA
    ecolGroupQuery:
      description: The ecological group of interest for the Neotoma taxon (from the Neotoma ecolgrouptypes table)
      in: query
      name: ecolgroup
      required: false
      schema:
        type: string
        example: Charcoal
    familyNameQuery:
      description: Family name (last name) of the the researcher (may use the % wildcard)
      in: query
      name: familyname
      required: false
      schema:
        type: string
    gpidPath:
      description: Numeric ID for the geopolitical unit.
      in: path
      name: gpid
      required: true
      schema:
        format: int32
        maximum: 11000
        minimum: 1
        type: integer
    gpidQuery:
      description: Numeric ID for the geopolitical unit from the Neotoma geopoliticalunits table.
      in: query
      name: gpid
      required: false
      schema:
        format: int32
        maximum: 11000
        minimum: 1
        type: integer
      examples:
        gpid:
          value: 756
          summary: A valid unique identifier for geopolitical units from Neotoma's geopoliticalunits table.
        gpids:
          value: 2155,313,5414
          summary: A set of unique identifiers, separated by commas.
    gpnameQuery:
      description: Name for a geopolitical unit.
      in: query
      name: gpname
      required: false
      schema:
        type: string
      examples:
        countryname:
          value: Canada
          summary: The name of a country, state or other region.
        countrynames:
          value: Italy, austria, switzerland
          summary: The name of a set of locations, separated by commas.
    keywordQuery:
      description: A valid keyword for samples within Neotoma. The list of valid names can be obtained through a call to the dbtables API call.
      in: query
      name: keyword
      required: false
      schema:
        format: string
        enum:
          - modern
          - pre-European
          - interglacial
          - bottom
          - beyond radiocarbon
    limitParam:
      description: The maximum number of records to be returned, default is 25.
      in: query
      name: limit
      required: false
      schema:
        default: 25
        format: int32
        maximum: 10000
        minimum: 1
        type: integer
    locQuery:
      description: |
        The geographic region of interest for the site, as a GeoJSON string or valid Well Known Text (WKT).  Assumed projection of EPSG:4376 unless otherwise defined.
      in: query
      name: loc
      required: false
      schema:
        type: string
      examples:
        SouthAmericangeoJSON:
          value: "{'type':'FeatureCollection','features':[{'type':'Feature','properties':{},'geometry':{'coordinates':[[[-73.300,-35.768],[-75.442,-43.787],[-64.059,-43.533],[-53.572,-38.844],[-55.043,-34.302],[-61.150,-33.904],[-68.248,-34.407],[-73.300,-35.768]]],'type':'Polygon'}}]}"
          summary: A geoJSON representation of a polygon that includes Argentina and Chile.
        EuropeanWKT:
          value: POLYGON ((12.49 45.53, 9.847 42.879, 16.982 40.812, 20.549 44.03, 14.736 46.266, 12.49 45.53))
          summary: A WKT formatted spatial polygon that includes land adjacent to the Adriatic sea.
    lowergpQuery:
      description: Should all lower ranked units below the target unit be returned?
      in: query
      name: lower
      required: false
      schema:
        default: false
        type: boolean
    occurrenceidPath:
      description: Valid Neotoma occurrence identifier (integer), either singly or in a comma separated list.
      in: path
      name: occurrenceid
      required: true
      schema:
        format: int32
        maximum: 10000000
        minimum: 1
        type: integer
    occurrenceidQuery:
      description: Valid Neotoma occurrence identifier (integer), either singly or in a comma separated list.
      in: query
      name: occurrenceid
      required: false
      schema:
        format: int32
        maximum: 10000000
        minimum: 0
        type: integer
    offsetParam:
      description: The offset for returned records when a limit is present.  Default is 0.
      in: query
      name: offset
      required: false
      schema:
        default: 0
        format: int32
        minimum: 0
        type: integer
    pollenidPath:
      description: |
        Unique pollen taxon identifier (from the Neotoma taxa table).
      in: path
      name: id
      required: true
      schema:
        format: int32
        maximum: 50000
        minimum: 1
        type: integer
    publicationidPath:
      description: |
        Unique publication identifier (from the Neotoma publication table).
      in: path
      name: publicationid
      required: true
      schema:
        format: int32
        maximum: 20000
        minimum: 1
        type: integer
    publicationidQuery:
      description: |
        Unique publication identifier (from the Neotoma publication table).
      in: query
      name: publicationid
      required: false
      schema:
        format: int32
        maximum: 20000
        minimum: 0
        exclusiveMinimum: true
        type: integer
    pubsearchQuery:
      description: A fulltext search string.  Either a literal portion of the article name, or keywords.
      in: query
      name: search
      required: false
      schema:
        type: string
    pubtypeQuery:
      description: The type of publication requested.
      in: query
      name: pubtype
      required: false
      schema:
        enum:
          - Legacy
          - Journal Article
          - Book Chapter
          - Authored Book
          - Edited Book
          - Master's Thesis
          - Doctoral Dissertation
          - Authored Report
          - Edited Report
          - Other Authored
          - Other Edited
          - Website
          - Undergraduate thesis
        type: string
    pubyearQuery:
      description: The year of publication, either as a single value or comma separated string.
      in: query
      name: year
      required: false
      schema:
        format: int32
        maximum: 2100
        minimum: 1500
        type: integer
    rankQuery:
      description: The unit rank.  Ranges from 1 (country) - 4 (e.g., parks).
      in: query
      name: rank
      required: false
      schema:
        maximum: 4
        minimum: 1
        type: integer
    taxaQuery:
      description: |
        The name of a taxon, or a unique taxon identifier within Neotoma (obtained from a call to tables). May be a comma separated list of taxonomic names or numeric identifiers. As elsewhere, the `%` sign can be used as a wildcard.
      name: taxa
      in: query
      required: false
      schema:
        type: string
    sitenameQuery:
      description: Name of the study site (may use the % wildcard). Note that Neotoma study site names are not unique. For example there are more than 15 sites in Neotoma named *Clear Lake*.
      in: query
      name: sitename
      required: false
      schema:
        example: Stern Excavation Site
        type: string
    siteidPath:
      description: Valid Neotoma site identifier (integer), either singly or in a comma separated list.
      in: path
      name: siteid
      required: true
      schema:
        format: int32
        maximum: 30000
        minimum: 1
        type: integer
    bufferQuery:
      description: Buffer distance for point of polygon in meters.
      in: query
      name: buffer
      required: false
      schema:
        format: int64
        minimum: 0
        maximum: 10000
        default: 10000
        type: integer
    siteidQuery:
      description: Valid Neotoma site identifier (integer), either singly or in a comma separated list.
      in: query
      name: siteid
      required: false
      schema:
        format: int32
        maximum: 30000
        minimum: 1
        type: integer
    tableQuery:
      description: Valid name for a Neotoma Table
      in: query
      name: table
      required: false
      schema:
        example: agetypes
        type: string
    tablePath:
      description: Valid name for a Neotoma Table
      in: path
      name: table
      required: true
      schema:
        example: agetypes
        type: string
    taxonNameQuery:
      description: |
        Taxon name or partial name. You can pass wildcard characters using `%`. For example, `%anis` will match
        with *Canis* as well as the plant taxon *Triodanis*. It will not match `Canis lupus` because there is no terminal wildcard. This can be accompished using `%anis%`.
      in: query
      name: taxonname
      required: false
      schema:
        example: Canis
        type: string
    taxaGroupQuery:
      description: |
        The taxonomic grouping the taxon belongs to, from the Neotoma taxagrouptypes table. You can get the list of acceptable taxa group types using the [dbtables API call](https://api.neotomadb.org/api-docs/#/Database%20tables/get_v2_0_data_dbtables) and passing *taxagrouptypes* as the table.
      in: query
      name: taxagroup
      required: false
      schema:
        example: Algae
        type: string
    taxastatusQuery:
      description: |
        The taxonomic extinction status of the taxon, either extinct (1, True) or extant (0, False).
      in: query
      name: status
      required: false
      schema:
        example: 1
        type: string
        enum: [0, 1, True, False]
    taxonidPath:
      description: |
        Unique taxonomic identifier (from the Neotoma taxon table).
      in: path
      name: taxonid
      required: true
      schema:
        format: int32
        maximum: 50000
        minimum: 1
        type: integer
    taxonidQuery:
      description: Unique taxonomic identifier (from the Neotoma taxon table).
      in: query
      name: taxonid
      required: false
      schema:
        maximum: 50000
        minimum: 1
        type: integer
    taxonnameQuery:
      description: Unique taxonomic name (from the Neotoma taxon table).
      in: query
      name: taxonname
      required: false
      schema:
        type: string
  schemas:
    constdbdescription:
      type: string
      nullable: true
      description: |
        A description provided by the stewards for the constituent database describing the database and its intended use.
    constdbresponse:
      type: object
      properties:
        status:
            type: string
        message:
          type: string
        query:
          type: object
          nullable: true
        data:
          type: array
          items:
            type: object
            properties:
              description:
                $ref: '#/components/schemas/constdbdescription'
              url:
                $ref: "#/components/schemas/url"
              contactname:
                $ref: "#/components/schemas/contactname"
              email:
                $ref: "#/components/schemas/email"
              datasettypes:
                description: |
                  An array of the unique dataset types for all datasets within the constituent database.
                type: array
                items:
                  type: string
                  nullable: true
              older:
                $ref: '#/components/schemas/ageold'
              younger:
                $ref: '#/components/schemas/ageyoung'
              datasets:
                description: |
                  A count of the number of unique datasets within the constituent database.
                type: integer
    datasetagerangeresponse:
      description: |
        The age bounds of a dataset, as defined by the chronology, generally the oldest and youngest sample ages for the dataset, for a given age type (<sup>14</sup>C years, calibrated radiocarbon, calendar years, etc.)
      properties:
        status:
            type: string
        message:
          type: string
        query:
          type: object
        data:
          type: array
          items:
            properties:
              older:
                $ref: '#/components/schemas/ageold'
              younger:
                $ref: '#/components/schemas/ageyoung'
              agetype:
                $ref: '#/components/schemas/agetype'
    datasetsShort:
      description: |
        A data response primarily for rapid access to site/dataset locations, providing only limited metadata.
      properties:
        status:
          type: string
        message:
          type: string
        data:
          type: array
          items:
            properties:
              siteid:
                $ref: '#/components/schemas/siteid'
              sitename:
                $ref: '#/components/schemas/sitename'
              datasetid:
                $ref: '#/components/schemas/datasetid'
              datasettype:
                $ref: '#/components/schemas/datasetid'
              coords:
                type: array
                items:
                  type: string
    lakesPoly:
      properties:
        status:
          type: string
        message:
          type: string
        data:
          type: array
          items:
            properties:
              hydrolakeid:
                type: integer
                description: |
                  Unique lake identifier in the [HydroLakes10k](https://www.hydrosheds.org/products/hydrolakes) database.
              lakename:
                type: string
                description: |
                  Name of lake or reservoir.<br>
                  This field is currently only populated for lakes with an area of at least 500km^2^; for large reservoirs where a name was available in the GRanD database; and for smaller lakes where a name was available in the GLWD database. [source PDF](https://data.hydrosheds.org/file/technical-documentation/HydroLAKES_TechDoc_v10.pdf)
              lakearea:
                description: Lake area in square kilometers.
                type: integer
              shorelen:
                description: Shore length/lake perimeter in kilometers.
                type: integer
              volume:
                type: number
                description: |
                  Total lake or reservoir volume, in million cubic meters (1*mcm* = 0.001 km^3^).<br>
                  For most polygons, this value represents the total lake volume as estimated using the geostatistical modeling approach by Messager et al. (2016). However, where either a reported lake volume (for lakes ≥ 500 km^2^) or a reported reservoir volume (from GRanD database) existed, the total volume represents this reported value. In cases of regulated lakes, the total volume represents the larger value between reported reservoir and modeled or reported lake volume. [source PDF](https://data.hydrosheds.org/file/technical-documentation/HydroLAKES_TechDoc_v10.pdf)
              avgdepth: 
                type: number
                description: |
                  Average lake depth, in meters.
                  Average lake depth is defined as the ratio between total lake volume (`volume`) and lake area (`lakearea`).
              watershedarea:
                type: number
                description: |
                  Area of the watershed associated with the lake, in square kilometers.<br>
                  The watershed area is calculated by deriving and measuring the upstream contribution area to the lake pour point using the HydroSHEDS drainage network map at 15 arc-second resolution.<br>
                  **-9999**: no data as lake pour point is not on HydroSHEDS landmask
              wkt_shape:
                type: string
                description: |
                  A Well-Known-Text representation of the lake, resolved to the appropriate precision.
    faunalPoly:
      properties:
        message:
          type: string
        data:
          type: array
          items:
            properties:
              gid:
                type: array
                items:
                  type: integer
                  format: int32
                nullable: true
              spid:
                type: array
                items:
                  type: integer
                  format: int32
                nullable: true
              sciname:
                type: array
                items:
                  type: string
                nullable: true
              geom:
                type: string
                nullable: true
    icesheetPoly:
      properties:
        message:
          type: string
        data:
          type: object
          properties:
            gid:
              type: array
              items:
                type: integer
                format: int32
            age:
              type: integer
              format: int32
            calibrated:
              type: integer
              format: int32
            geom:
              type: string
    address:
      description: A physical address, as a single string.
      example: 550 N Park St, Madison WI, USA
      type: string
      nullable: true
    ageold:
      example: 1000
      nullable: true
      type: number
    agerange:
      description: |
        The set of ages describing a sample age measured with uncertainty. Often described as the accepted age of the sample and then a younger and older age defined by ±1SD. The age range may be further defined in chronology or dataset notes.
      properties:
        ageold:
          $ref: '#/components/schemas/ageold'
        agetype:
          $ref: '#/components/schemas/agetype'
        ageyoung:
          $ref: '#/components/schemas/ageyoung'
      type: object
    agetype:
      enum:
        - Calendar years AD/BC
        - Calendar years BP
        - Calibrated radiocarbon years BP
        - Radiocarbon years BP
        - Varve years BP
      type: string
    ageyoung:
      example: -35
      nullable: true
      type: number
    altitude:
      example: 0
      format: int32
      maximum: 9000
      minimum: -500
      type: integer
    pollenresponse:
      type: object
    datasetelcresponse:
      type: object
    publicationsresponse:
      type: object
    authorpiresponse:
      properties:
        data:
          items:
            properties:
              getpeople:
                type: string
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    chronology:
      properties:
        agetype:
          $ref: '#/components/schemas/agetype'
        chronologyName:
          example: NAPD 1
          type: string
        chronologyid:
          example: 1
          type: integer
        controls:
          properties:
            age:
              example: -45
              type: number
            chroncontrolid:
              example: 5645
              type: integer
            controllimits:
              properties:
                ageolder:
                  $ref: '#/components/schemas/ageold'
                ageyounger:
                  $ref: '#/components/schemas/ageyoung'
              type: object
            controltype:
              example: Core top
              type: string
            depth:
              example: 0.5
              type: number
            thickness:
              example: 2
              type: number
          type: object
        dataset:
          properties:
            datasetid:
              $ref: '#/components/schemas/datasetid'
            datasettype:
              type: string
          type: object
        datePrepared:
          $ref: '#/components/schemas/date'
        default:
          example: true
          type: boolean
        modelType:
          example: linear interpolation
          type: string
        preparedby:
          properties:
            contactid:
              example: 44
              type: integer
            contactname:
              example: Grimm, Eric Christopher
              type: string
            familyname:
              example: Grimm
              type: string
            firstname:
              example: Eric
              type: string
            initials:
              example: E.C.
              type: string
          type: object
        reliableagespan:
          properties:
            older:
              example: 6490
              type: integer
            younger:
              example: -30
              type: integer
          type: object
      type: object
    chronologyv2_0:
      properties:
        agetype:
          example: Calibrated radiocarbon years BP
          type: string
        chronologyName:
          example: NAPD 1
          type: string
        chronologyid:
          example: 1
          type: integer
        controls:
          properties:
            age:
              example: -45
              type: number
            chroncontrolid:
              example: 5645
              type: integer
            controllimits:
              properties:
                ageolder:
                  $ref: '#/components/schemas/ageold'
                ageyounger:
                  $ref: '#/components/schemas/ageyoung'
              type: object
            controltype:
              example: Core top
              type: string
            depth:
              example: 0.5
              type: number
            thickness:
              example: 2
              type: number
          type: object
        dataset:
          properties:
            datasetid:
              $ref: '#/components/schemas/datasetid'
            datasettype:
              type: string
          type: object
        datePrepared:
          $ref: '#/components/schemas/date'
        default:
          example: true
          type: boolean
        modelType:
          example: linear interpolation
          type: string
        preparedby:
          properties:
            contactid:
              example: 44
              type: integer
            contactname:
              example: Grimm, Eric Christopher
              type: string
            familyname:
              example: Grimm
              type: string
            firstname:
              example: Eric
              type: string
            initials:
              example: E.C.
              type: string
          type: object
        reliableagespan:
          properties:
            older:
              example: 6490
              type: integer
            younger:
              example: -30
              type: integer
          type: object
      type: object
    chronologyv2response:
      properties:
        data:
          items:
            properties:
              chronology:
                $ref: '#/components/schemas/chronologyv2_0'
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    collectiontyperesponse:
      properties:
        data:
          items:
            properties:
              colltype:
                example: Isolated specimen
                type: string
              colltypeid:
                example: 8
                type: integer
            type: object
          type: array
        message:
          type: string
          pattern: '.*'
        status:
          type: string
          pattern: '.*'
      type: object
    collectionunit:
      example: 15-1
      nullable: true
      type: string
    collectionunitid:
      example: 666
      format: int64
      minimum: 1
      type: integer
    contact:
      properties:
        address:
          $ref: '#/components/schemas/address'
        aliasid:
          $ref: '#/components/schemas/aliasid'
        contactid:
          $ref: '#/components/schemas/contactid'
        contactname:
          $ref: '#/components/schemas/contactname'
        contactstatus:
          $ref: '#/components/schemas/contactstatus'
        email:
          $ref: '#/components/schemas/email'
        phone:
          type: string
          nullable: true
        fax:
          type: string
          nullable: true
        familyname:
          example: Goring
          type: string
        givennames:
          example: Simon
          type: string
          nullable: true
        leadinginitials:
          example: S. J.
          type: string
          nullable: true
        notes:
          example: This user is a member of the Neotoma Leadership Team.
          type: string
          nullable: true
        suffix:
          example: Esq.
          type: string
          nullable: true
        title:
          example: Lord Mayor
          type: string
          nullable: true
        url:
          $ref: '#/components/schemas/url'
      type: object
    recdatemodified:
      type: string
    recdatecreated:
      type: string
    aliasid:
      example: 123
      format: int64
      type: integer
    contactid:
      example: 123
      format: int64
      minimum: 1
      type: integer
    contactname:
      example: Goring, Simon J
      type: string
      nullable: true
    contactresponsev15:
      properties:
        data:
          type: array
          items:
            properties:
              address:
                $ref: '#/components/schemas/address'
              contactid:
                $ref: '#/components/schemas/contactid'
              contactname:
                $ref: '#/components/schemas/contactname'
              familyname:
                example: Goring
                type: string
              givennames:
                example: Simon
                type: string
                nullable: true
              url:
                $ref: '#/components/schemas/url'
            minItems: 0
        status:
          $ref: '#/components/schemas/status'
        success:
          $ref: '#/components/schemas/success'
        message:
          $ref: '#/components/schemas/message'
      type: object
    contactresponse:
      properties:
        data:
          type: array
          items:
                $ref: '#/components/schemas/contact'
        status:
          $ref: '#/components/schemas/status'
      type: object
    contactfromsite:
      properties:
        data:
          type: array
          items:
                $ref: '#/components/schemas/contact'
        status:
          $ref: '#/components/schemas/status'
      type: object
    contactstatus:
      type: string
      nullable: true
    dataset:
      properties:
        data:
          items:
            properties:
              dataset:
                properties:
                  database:
                    type: string
                  datasetid:
                    $ref: '#/components/schemas/datasetid'
                  datasetnotes:
                    $ref: '#/components/schemas/datasetnotes'
                  datasetpi:
                    items:
                      properties:
                        contact:
                          $ref: '#/components/schemas/contact'
                    type: array
                  datasettype:
                    $ref: '#/components/schemas/datasettype'
                  doi:
                    items:
                      properties:
                        doi:
                          $ref: '#/components/schemas/doi'
                    type: array
                type: object
              site:
                properties:
                  altitude:
                    type: integer
                  collectionunit:
                    type: string
                  collectionunitid:
                    $ref: '#/components/schemas/collectionunitid'
                  geography:
                    format: geoJSON
                    type: string
                  handle:
                    type: string
                  sitedescription:
                    type: string
                  siteid:
                    $ref: '#/components/schemas/siteid'
                  sitename:
                    $ref: '#/components/schemas/sitename'
                  sitenotes:
                    $ref: '#/components/schemas/sitenotes'
                  unittype:
                    type: string
                type: object
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
        success:
          $ref: '#/components/schemas/success'
      type: object
    datasetTypes:
      properties:
        data:
          items:
            properties:
              datasettype:
                $ref: '#/components/schemas/datasettype'
              datasettypeid:
                example: 14
                type: integer
            type: object
          type: array
        message:
          type: string
        status:
          type: string
      type: object
    datasetid:
      example: 666
      format: int64
      maximum: 60000
      minimum: 1
      type: integer
    datasetnotes:
      example: This dataset was digitized from an original publication in Finnish.
      type: string
    siteresponse:
      type: object
    datasetresponsev2_0:
      properties:
        data:
          $ref: '#/components/schemas/datasetv2'
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    datasetselcresponse:
      properties:
        data:
          items:
            properties:
              site:
                properties:
                  altitude:
                    $ref: '#/components/schemas/altitude'
                  collectionunit:
                    $ref: '#/components/schemas/collectionunit'
                  collectionunitid:
                    $ref: '#/components/schemas/collectionunitid'
                  datasets:
                    type: object
                  geography:
                    $ref: '#/components/schemas/geography'
                  handle:
                    $ref: '#/components/schemas/handle'
                  sitedescription:
                    $ref: '#/components/schemas/sitedescription'
                  siteid:
                    $ref: '#/components/schemas/siteid'
                  sitename:
                    $ref: '#/components/schemas/sitename'
                  sitenotes:
                    $ref: '#/components/schemas/sitenotes'
                  unittype:
                    $ref: '#/components/schemas/unittype'
                type: object
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    datasetshort:
      items:
        properties:
          datasetid:
            $ref: '#/components/schemas/datasetid'
          datasettype:
            $ref: '#/components/schemas/datasettype'
        type: object
      type: array
    datasettype:
      example: geochemistry
      type: string
    datasettyperesponse:
      properties:
        data:
          items:
            properties:
              getdatasettypes:
                type: string
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    datasetv2:
      properties:
        data:
          items:
            properties:
              site:
                properties:
                  altitude:
                    $ref: '#/components/schemas/altitude'
                  collectionunit:
                    $ref: '#/components/schemas/collectionunit'
                  collectionunitid:
                    $ref: '#/components/schemas/collectionunitid'
                  dataset:
                    items:
                      properties:
                        agerange:
                          $ref: '#/components/schemas/agerange'
                        database:
                          type: integer
                        datasetid:
                          $ref: '#/components/schemas/datasetid'
                        datasetnotes:
                          $ref: '#/components/schemas/datasetnotes'
                        datasetpi:
                          type: array
                          items:
                            type: object
                        datasettype:
                          $ref: '#/components/schemas/datasettype'
                        doi:
                          items:
                            type: string
                          type: array
                      type: object
                    type: array
                  geography:
                    $ref: '#/components/schemas/geography'
                  handle:
                    $ref: '#/components/schemas/handle'
                  sitedescription:
                    $ref: '#/components/schemas/sitedescription'
                  siteid:
                    $ref: '#/components/schemas/siteid'
                  sitename:
                    $ref: '#/components/schemas/sitename'
                  sitenotes:
                    $ref: '#/components/schemas/sitenotes'
                  unittype:
                    $ref: '#/components/schemas/unittype'
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    date:
      example: '2013-09-30'
      format: date
      type: string
    datetime:
      example: '2013-09-30T21:02:51.000Z'
      format: dateTime
      type: string
    dbtablenameresponse:
      properties:
        data:
          type: array
          items:
            type: object
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    dbtables:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
    dbtablesv1_5:
      properties:
        data:
          items:
            type: object
          type: array
    depositionalresponse:
      properties:
        data:
          items:
            properties:
              getdeptenvtypesroot:
                type: string
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    doi:
      example: 10.2157/abba1234
      type: string
    doiresponse:
      properties:
        data:
          items:
            properties:
              datasetid:
                $ref: '#/components/schemas/datasetid'
              dois:
                nullable: true
                type: string
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    downloadv1point5:
      properties:
        data:
          type: object
        message:
          $ref: '#/components/schemas/message'
        success:
          $ref: '#/components/schemas/success'
      type: object
    downloadv2:
      properties:
        datasetid:
          $ref: '#/components/schemas/datasetid'
        record:
          properties:
            chronologies:
              items:
                $ref: '#/components/schemas/chronology'
              type: array
            data:
              properties:
                dataset:
                  items:
                    $ref: '#/components/schemas/dataset'
                  type: array
                samples:
                  type: string
              type: object
          type: object
        success:
          $ref: '#/components/schemas/success'
      type: object
    email:
      example: goring@wisc.edu
      format: email
      nullable: true
      type: string
      pattern: (?:[a-z0-9!#$%&'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+\/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])
    geography:
      example: '{"type":"Point","crs":{"type":"name","properties":{"name":"EPSG:4326"}},"coordinates":[-75.25,55.09167]}'
      type: string
    geopolitical:
      properties:
        data:
          items: 
            properties:
              geopoliticalid:
                $ref: '#/components/schemas/geopoliticalid'
              geopoliticalname:
                $ref: '#/components/schemas/geopoliticalname'
              geopoliticalunit:
                $ref: '#/components/schemas/geopoliticalunit'
              highergeopoliticalid:
                $ref: '#/components/schemas/highergeopoliticalid'
              rank:
                example: 2
                format: int32
                type: integer
              recdatecreated:
                $ref: '#/components/schemas/datetime'
              recdatemodified:
                $ref: '#/components/schemas/datetime'
          type: array
        status:
          $ref: '#/components/schemas/status'
    geopoliticalid:
      example: 757
      format: int32
      type: integer
    geopoliticalname:
      example: Canada
      type: string
    geopoliticalunit:
      example: province
      type: string
    geopoliticalv1_5:
      properties:
        data:
          items:
            properties:
              geopoliticalid:
                $ref: '#/components/schemas/geopoliticalid'
              geopoliticalname:
                example: Antarctica
                type: string
            type: object
          type: array
        status:
          $ref: '#/components/schemas/status'
        success:
          $ref: '#/components/schemas/success'
      type: object
    handle:
      example: HOSEHEAD
      nullable: true
      type: string
    highergeopoliticalid:
      example: 756
      format: int32
      type: integer
    keywordresponse:
      properties:
        data:
          items:
            properties:
              keywords:
                type: string
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    limit:
      default: 25
      minimum: 1
      type: integer
    lithology:
      properties:
        depth:
          properties:
            bottom:
              type: number
            top:
              type: number
          type: object
        description:
          type: string
        lithologyid:
          minimum: 1
          type: integer
        lowerboundary:
          example: gradational over 10 cm
          nullable: true
          type: string
      type: object
    lithologyresponse:
      properties:
        data:
          items:
            properties:
              datasetid:
                $ref: '#/components/schemas/datasetid'
              lithology:
                $ref: '#/components/schemas/lithology'
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    message:
      example: Returned a vaild response.
      type: string
    occurrence:
      properties:
        data:
          items:
            properties:
              ages:
                properties:
                  age:
                    format: int64
                    type: integer
                  ageolder:
                    $ref: '#/components/schemas/ageold'
                  ageyounger:
                    $ref: '#/components/schemas/ageyoung'
                type: object
              occurrence:
                format: int64
                type: integer
              sample:
                type: object
                properties:
                  sampleid:
                    $ref: '#/components/schemas/sampleid'
                  taxonid:
                    $ref: '#/components/schemas/taxonid'
                  taxonname:
                    $ref: '#/components/schemas/taxonname'
                  value:
                    $ref: '#/components/schemas/value'
                  variableunits:
                    $ref: '#/components/schemas/sampleunits'
              site:
                properties:
                  altitude:
                    type: integer
                  database:
                    type: string
                  datasetid:
                    $ref: '#/components/schemas/datasetid'
                  datasettype:
                    $ref: '#/components/schemas/datasettype'
                  location:
                    type: string
                  siteid:
                    $ref: '#/components/schemas/siteid'
                  sitename:
                    $ref: '#/components/schemas/sitename'
                type: object
              taxon:
                properties:
                  taxonid:
                    format: int64
                    type: integer
                  taxonname:
                    type: string
                type: object
            type: object
          type: array
        message:
          type: string
        status:
          type: string
        success:
          type: integer
      type: object
    occurrencev1_5:
      properties:
        data:
          items:
            properties:
              ages:
                properties:
                  age:
                    format: int64
                    nullable: true
                    type: integer
                  ageolder:
                    $ref: '#/components/schemas/ageold'
                  ageyounger:
                    $ref: '#/components/schemas/ageyoung'
                type: object
              occurrence:
                format: int64
                type: integer
              sample:
                format: int64
                type: integer
              site:
                properties:
                  altitude:
                    type: integer
                  database:
                    type: string
                  datasetid:
                    $ref: '#/components/schemas/datasetid'
                  datasettype:
                    $ref: '#/components/schemas/datasettype'
                  location:
                    type: string
                  siteid:
                    $ref: '#/components/schemas/siteid'
                  sitename:
                    $ref: '#/components/schemas/sitename'
                type: object
              taxon:
                properties:
                  taxonid:
                    format: int64
                    type: integer
                  taxonname:
                    type: string
                type: object
            type: object
          type: array
        message:
          type: string
        status:
          type: string
        success:
          type: integer
      type: object
    offset:
      default: 0
      minimum: 0
      type: integer
    pollen:
      properties:
        Author:
          type: string
        EcolGroups:
          items:
            type: string
          type: array
        Extinct:
          type: boolean
        HigherTaxonID:
          format: int32
          type: integer
        Notes:
          type: string
        PublicationID:
          format: int32
          type: integer
        TaxaGroupID:
          type: string
        TaxonCode:
          type: string
        TaxonID:
          format: int32
          type: integer
        TaxonName:
          type: string
    publication:
      properties:
        Authors:
          items:
            type: string
          type: array
        Citation:
          type: string
        PubType:
          type: string
        PublicationID:
          type: integer
        Year:
          type: string
    publications:
      properties:
        Authors:
          items:
            type: string
          type: array
        Citation:
          type: string
        PubType:
          type: string
        PublicationID:
          type: integer
        Year:
          type: string
    sampleid:
      type: integer
    sampleunits:
      type: string
      enum: ['μm', 'μm^2/ml', 'μm^2/pollen concentration', '1-5 scale', 'cm', 'cm^2', 'cm^2/ml', 'fragments/ml', 'g', 'g/ml', 'grains/aliquot', 'grains/g', 'grains/g sample', 'grains/ml', 'grains/tablet', 'mmho', 'ml', 'MNI', 'NISP', 'number', 'number/ml', 'particles/ml', 'percent', 'percent after LOI', 'percent dry mass', 'present/absent', 'units not specified', 'NISP digitized', 'percent digitized', '°C', 'μS', 'meq/L', 'mg/L', 'Spaulding scale', 'per mille', 'number/g', 'm', 'MNE', 'NISP/100 ml', 'g/m^2', 'mm^2/ml', 'particles/cm^2/yr', '1-4 scale', 'elemental ratio', 'ppm', 'individual specimen', 'mg/L CaCO3', 'μg/L', 'l', 'valves/g', 'NISP/ml', 'mS/cm', 'μg/g', 'mg N/L', 'μS/cm', 'NTU', 'μmho/cm', 'grains/mg', 'mg', 'number/1000', 'κ (SI) × 10^-6', 'κ (cgs) × 10^-6', 'grams', '1-2 scale', 'ratio', 'PTU', 'κ (cgs) × 10^-5', 'Pt-Co scale', 'ppb', 'μeq/L', 'Pt-Co units', 'μS/cm 25°C', 'TCU', '1-3 scale', 'particles/g', 'nl', 'mm', 'number×1000', 'mm^3', 'fraction total alkanes', 'response at m/z = 1302', 'response at m/z = 1050', 'response at m/z = 1292', 'response at m/z = 1018', 'response at m/z = 1020', 'response at m/z = 1022', 'response at m/z = 1032', 'response at m/z = 1034', 'response at m/z = 1036', 'response at m/z = 1046', 'response at m/z = 1048', 'spheres/mL', 'per mille VSMOW', 'peak area', 'cm^3', 'yr/cm', 'yr/m', 'yr', 'mm^2', 'kcps', 'kcps^2', 'valves/ml', 'Pt-Co', 'μmol/L', 'κ (SI) × 10^-5', 'concentration', 'mm^2/cm^2/yr', 'grains/cm^2*yr', 'NISP+', 'Unit', 'µS/cm 25°C', 'µg/L', 'units', 'µS/cm', 'mmol/L', 'µeq/L', 'Index', 'umol/L', 'cm^2/cm^3', 'C°', 'SD', '>2 mm', '>5 mm', 'fragment', '>1 mm', 'per mille VPDB', 'per mille air N', 'mg/ml', 'particles/cm^3', 'cm^2/yr', 'per mille VPDB/17O', 'atomic ratio', 'mg/100 mg', 'per mille VSMOV', 'error', '>10 mm', 'mm^3/cm^3', 'number/tablet', 'mg/g', 'mg/kg', 'm^2', 'present', 'SI', 'µS/cm 25C', 'cc', 'per mil, PDB', 'per mil, air', 'percent dry weight', 'µg/kg', 'Mean uM', 'uM', 'μS/cm25°C', 'fragments/l', 'particles/l', 'NISP/tablet', 'grains/cm²/yr', 'moisture weight %', 'particles', 'count', 'class', 'volume-percent', 'mm2', 'cm3', 'mm/year', 'promil', 'MS (SI)', '#/cm2/a', '#/cm3', '#/g', '#', '#/cc', '#/cm2/kyr', '% dry wt', 'cps', 'grains/cm3', 'particles/cm²/yr', 'g/L', 'cm²', 'g/cm3', 'g/cm2', 'pCi/g', 'Bg/g', 'Bg/kg', 'dpm/g', 'g/cm2/yr', 'g/m2/yr', 'kg/m2/yr', 'μm^2', 'grains/cm^3', 'presence/absence', '#/tablet', 'grains/cc', 'count of reads', 'count of PCR replicates', 'spores/tablet', 'cm/yr', 'presence/abence', 'cyst/cm2/yr', 'cysts/g']
    sitedescription:
      example: Lake is located in a pre-glacial gorge of the Wisconsin river cut through the Baraboo Hills, a bedrock high. The valley is dammed at both ends by terminal moraines deposited by the Green Bay lobe, which flowed around the Baraboo Hills. Lake is fed by groundwater. Surrounding vegetation, white-black-bur oak.
      nullable: true
      type: string
    siteid:
      description: |
        A unique integer site identifier used internally within the Neotoma Database as a primary key for the `ndb.sites` data table, and as a foreign key in many other tables that relate to the sites table.
      example: 666
      format: int64
      minimum: 1
      type: integer
    sitename:
      description: |
        A non-unique name for the site. This may be inherited from the location (a lake name for example), or may be an author generated name, as used in a publication. There is no standardization for site names in Neotoma.
      example: Devils Lake
      type: string
    sitenotes:
      description: |
        An open text field used to describe additional information about the site.
      example: This record has some little things that seem funny about it.
      nullable: true
      type: string
    sitesv1point5:
      properties:
        data:
          items:
            properties:
              altitude:
                $ref: '#/components/schemas/altitude'
              collectionunit:
                $ref: '#/components/schemas/collectionunit'
              collectionunitid:
                $ref: '#/components/schemas/collectionunitid'
              datasetid:
                $ref: '#/components/schemas/datasetid'
              datasettype:
                $ref: '#/components/schemas/datasettype'
              geography:
                $ref: '#/components/schemas/geography'
              handle:
                $ref: '#/components/schemas/handle'
              sitedescription:
                $ref: '#/components/schemas/sitedescription'
              siteid:
                $ref: '#/components/schemas/siteid'
              sitename:
                $ref: '#/components/schemas/sitename'
              unittype:
                $ref: '#/components/schemas/unittype'
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
        success:
          $ref: '#/components/schemas/success'
    sitesv2:
      properties:
        altitude:
          $ref: '#/components/schemas/altitude'
        collectionunits:
          items:
            properties:
              collectionunit:
                $ref: '#/components/schemas/collectionunit'
              collectionunitid:
                $ref: '#/components/schemas/collectionunitid'
              collectionunittype:
                example: Core
                type: string
              datasets:
                $ref: '#/components/schemas/datasetshort'
              handle:
                $ref: '#/components/schemas/handle'
            type: object
          type: array
        geography:
          $ref: '#/components/schemas/geography'
        sitedescription:
          $ref: '#/components/schemas/sitedescription'
        siteid:
          $ref: '#/components/schemas/siteid'
        sitename:
          $ref: '#/components/schemas/sitename'
    sitesv2response:
      properties:
        data:
          items:
            $ref: '#/components/schemas/sitesv2'
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
    status:
      type: string
    success:
      enum:
        - 0
        - 1
      type: integer
    summaryalldata:
      properties:
        data:
          properties:
            data:
              type: array
              items:
                type: object
            query:
              type: object
          type: object
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    summarydatabase:
      properties:
        data:
          properties:
            data:
              type: array
              items:
                type: object
            query:
              type: object
          type: object
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    summarydatatype:
      properties:
        data:
          properties:
            data:
              type: array
              items:
                type: object
            query:
              type: object
          type: object
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    taphonomyresponse:
      properties:
        data:
          items:
            nullable: true
            properties:
              gettaphonomicsystems:
                type: string
            type: object
          minItems: 0
          nullable: true
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    taxa:
      properties:
        author:
          type: string
          nullable: true
        ecolgroup:
          type: string
        highertaxonid:
          format: int32
          type: integer
        publicationid:
          format: int32
          type: integer
          nullable: true
        publication:
          type: string
          nullable: true
        status:
          type: string
        taxonid:
          format: int32
          type: integer
        taxonname:
          type: string
    taxaInDatasets:
      properties:
        data:
          items:
            properties:
              datasettypeids:
                items:
                  type: integer
                type: array
              taxongroupid:
                type: string
              taxonid:
                type: integer
              taxonname:
                type: string
            type: object
          type: array
        message:
          type: string
        status:
          type: string
        success:
          type: integer
      type: object
    taxaInDatasetsv1_5:
      properties:
        data:
          items:
            properties:
              datasettypeids:
                items:
                  type: integer
                type: array
              taxongroupid:
                type: string
              taxonid:
                type: integer
              taxonname:
                type: string
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
        success:
          $ref: '#/components/schemas/success'
      type: object
    datasetuploadresponse:
      description: |
        A data response from the API showing how many datasets were uploaded each month, generally by constituent database.
      properties:
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
        data:
          type: array
          items:
            properties:
              count:
                type: integer
              month:
                type: string
    taxagroupresponse:
      properties:
        data:
          items:
            properties:
              gettaxagrouptypes:
                type: string
            type: object
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    taxonid:
      type: integer
      format: int64
    taxonname:
      type: string
    taxonresponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/taxa'
          type: array
        message:
          $ref: '#/components/schemas/message'
        status:
          $ref: '#/components/schemas/status'
      type: object
    unittype:
      example: Modern
      type: string
    url:
      example: http://neotomadb.org
      format: url
      type: string
      nullable: true
    value:
      type: number
info:
  contact:
    email: goring@wisc.edu
    name: Simon J Goring
    url: http://goring.org
  description: >-
    The [Neotoma Paleoecology Database](https://www.neotomadb.org) is a global database of fossils 
    from the last 5.2 million years. All fossil records in Neotoma are reported with metadata that 
    places the sample in space and in time, and provides additional information about taxonomy, 
    publication history, and the models that are used to estimate the sample age.


    The API is structured to provide users with reliable JSON responses from the live Neotoma Database. 
    Neotoma provides several tools to work with researcher submitted data:

      * [Neotoma Explorer](https://apps.neotomadb.org/explorer): A visual, interactive data explorer.
      * [neotoma2 R package](https://cran.r-project.org/web/packages/neotoma2/index.html): A tool for obtaining and manipulating paleoecological data in R.
      
    
    **Neotoma is funded by the National Sciences Foundation of the United States ([Award 1948962](https://nsf.gov/awardsearch/showAward?AWD_ID=1948926))**.

      <a href=https://localcontextshub.org/institutions/view/122/><img alt="Local Contexts Open to Collaborate Logo" src=https://storage.googleapis.com/local-contexts-hub.appspot.com/labels/notices/ci-open-to-collaborate.svg width=50 style="align:center;"/></a>
      <p>Our institution is committed to the development of new modes of collaboration, engagement, and partnership with Indigenous peoples for the care and stewardship of past and future heritage collections.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  termsOfService: 'no'
  title: Neotoma API
  version: 2.0-oas3
openapi: 3.0.0
paths:
  /v2.0/apps/constdb:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/constdbresponse'
          description: |
            Returns metadata about each constituent database in Neotoma, including Summary Informationrmation about dataset types within the database and the age spans of the records in the database.
      tags:
        - Database metadata
        - Summary Informationrmation
        - v2.0
  /v2.0/apps/constdb/datasetages:
    get:
      parameters:
        - $ref: '#/components/parameters/dbidQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetagerangeresponse'
          description: |
            Returns an ordered array (from earliest to latest) of upload counts by month (YYYY/MM/DD; all days as 01). Months with no uploads are excluded.
      tags:
        - Dataset metadata
        - Summary Information
        - v2.0
  /v2.0/apps/constdb/datasetuploads:
    get:
      parameters:
        - $ref: '#/components/parameters/dbidQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetuploadresponse'
          description: |
            Returns an ordered array (from earliest to latest) of upload counts by month (YYYY/MM/DD; all days as 01). Months with no uploads are excluded.
      tags:
        - Dataset metadata
        - Summary Information
        - v2.0
  /v2.0/apps/constdb/datasets:
    get:
      parameters:
        - $ref: '#/components/parameters/dbidQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetsShort'
          description: |
            Returns the set of datasets contained within a constituent database, identified by the constituent database identifier. Used for quick landing page generation.
      tags:
        - Dataset metadata
        - v2.0
  /v1.5/apps/DatasetTypes:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetTypes'
          description: Returns the set of dataset types supported by Neotoma.
      tags:
        - Database tables
        - v1.5
  /v1.5/apps/TaxaInDatasets:
    get:
      description: The set of all taxa, and a list of all the datasets in which each taxon appears.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/taxaInDatasetsv1_5'
          description: An array of taxon identities with associated dataset IDs.
      summary: Lists all Neotoma taxa (alphebetically) and the dataset types in which the taxa appear.
      tags:
        - Taxonomic metadata
        - v1.5
  /v1.5/apps/collectionTypes:
    get:
      operationId: getCollTypes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collectiontyperesponse'
          description: Returns the set of collectiontypes recorded in Neotoma.
      summary: Return the list of collection types.
      tags:
        - Database tables
        - v1.5
  /v1.5/data/contacts/{contactid}:
    get:
      description: Returns researcher contact information associated with a record.
      parameters:
        - description: Unique contact identifier.
          in: path
          name: contactid
          required: true
          schema:
            format: int64
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contactresponsev15'
          description: Contact
      summary: Contact information for Neotoma contributors.
      tags:
        - Contact metadata
        - v1.5
  /v1.5/data/datasets/{datasetid}:
    get:
      description: Returns information about Neotoma dataset
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: An array of datasets.
      summary: Dataset information.
      tags:
        - Dataset metadata
        - v1.5
  /v1.5/data/downloads/{datasetid}:
    get:
      description: Returns the named Neotoma Database table.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/downloadv1point5'
          description: Returned download object.
      summary: Returns the named Neotoma Database table.
      tags:
        - Data download
        - v1.5
  /v1.5/data/geopoliticalunits:
    get:
      parameters:
        - $ref: '#/components/parameters/gpidQuery'
        - $ref: '#/components/parameters/gpnameQuery'
        - $ref: '#/components/parameters/rankQuery'
        - $ref: '#/components/parameters/lowergpQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/geopoliticalv1_5'
          description: An array of geopolitical units.
      summary: Returns information about geopolitical units.
      tags:
        - Geopolitical metadata
        - v1.5
  /v1.5/data/geopoliticalunits/{gpid}:
    get:
      parameters:
        - $ref: '#/components/parameters/gpidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/geopolitical'
          description: An array of geopolitical units.
      summary: Returns information about geopolitical units.
      tags:
        - Geopolitical metadata
        - v1.5
  /v1.5/data/occurrence/{occurrenceid}:
    get:
      description: Given a unique occurrence identifier associated with a unique occurrence in Neotoma, return individual occurrence information for the sample.
      parameters:
        - $ref: '#/components/parameters/occurrenceidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/occurrencev1_5'
          description: A single occurrence object.
      summary: Occurrence information for a taxon and sample.
      tags:
        - Occurrence metadata
        - v1.5
  /v1.5/data/sites/{siteid}:
    get:
      description: Returns information about Neotoma publications
      parameters:
        - $ref: '#/components/parameters/siteidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sitesv1point5'
          description: An array of site elements.
      summary: Site information.
      tags:
        - Site metadata
        - v1.5
  /v1.5/dbtables/{table}:
    get:
      description: Returns the named Neotoma Database table.  An empty query returns a list of all Neotoma tables.
      parameters:
        - description: Neotoma database table name.
          example: geochrontypes
          in: path
          name: table
          required: true
          schema:
            example: agetypes
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/dbtablesv1_5'
                  message:
                    $ref: '#/components/schemas/message'
                  status:
                    $ref: '#/components/schemas/status'
                  success:
                    $ref: '#/components/schemas/success'
                type: object
          description: Returned table.
      summary: Returns the named Neotoma Database table.
      tags:
        - Database tables
        - v1.5
  /v2.0/data/spatial/faunal:
    get:
      parameters:
        - $ref: '#/components/parameters/scinameQuery'
        - $ref: '#/components/parameters/projQuery'
        - $ref: '#/components/parameters/precQuery'
      responses:
        '200':
          description: |
            An object containing all matched species names, identifiers and a GeoJSON polygon representing the UNIONed ranges for the selected species. All data is derived from:<br>
            * Mammal Diversity Database. (2020). Mammal Diversity Database (Version 1.2) [Data set]. Zenodo. DOI: [10.5281/zenodo.4139818](https://doi.org/10.5281/zenodo.4139818).<br>
            * Map of Life. (2021). Mammal range maps harmonised to the Mammals Diversity Database [Data set]. Map of Life. [10.48600/MOL-48VZ-P413](https://doi.org/10.48600/MOL-48VZ-P413)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/faunalPoly'
      tags:
        - External data
        - v2.0
        - Mammals
        - Spatial
  /v2.0/data/spatial/icesheet:
    get:
      parameters:
        - $ref: '#/components/parameters/ageQuery'
        - $ref: '#/components/parameters/projQuery'
        - $ref: '#/components/parameters/precQuery'
      responses:
        '200':
          description: |
            An object containing glacial extents for the selected time period (in **calibrated radiocarbon years**).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/icesheetPoly'
      tags:
        - External data
        - v2.0
        - Glaciares
        - Spatial
  /v2.0/data/spatial/lakes:
    get:
      parameters:
        - $ref: '#/components/parameters/siteidQuery'
        - $ref: '#/components/parameters/bufferQuery'
        - $ref: '#/components/parameters/precQuery'
        - $ref: '#/components/parameters/projQuery'
      responses:
        '200':
          description: |
            An object containing all matched lakes within some buffer distance of a site. Data derived from the [HydroLakes database](https://www.hydrosheds.org/products/hydrolakes):<br>
            * Messager, M.L., Lehner, B., Grill, G., Nedeva, I., Schmitt, O. (2016). Estimating the volume and age of water stored in global lakes using a geo-statistical approach. *Nature Communications*, 7: 13603. doi: [10.1038/ncomms13603](https://doi.org/10.1038/ncomms13603)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lakesPoly'
      tags:
        - External data
        - v2.0
        - Lake morphometry
        - Spatial
  /v2.0/apps/authorpis:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/authorpiresponse'
          description: A table of Neotoma collection types.
      tags:
        - Collection units
        - v2.0
  /v2.0/apps/collectiontypes:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collectiontyperesponse'
          description: A table of Neotoma collection types.
      tags:
        - Collection units
        - v2.0
  /v2.0/apps/datasettypes:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasettyperesponse'
          description: A table of Neotoma collection types.
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/apps/depositionalenvironments/root:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/depositionalresponse'
          description: A table of Neotoma collection types.
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/apps/keywords:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keywordresponse'
          description: A list of all keywords used for analysis units in the database.
      tags:
        - Analysis Unit Keywords
        - v2.0
  /v2.0/apps/taphonomysystems:
    get:
      parameters:
        - description: Unique dataset type identifier.
          in: query
          name: datasettypeid
          required: true
          schema:
            format: int64
            maximum: 26
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/taphonomyresponse'
          description: A table of Neotoma collection types.
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/apps/taxagrouptypes:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/taxagroupresponse'
          description: A table of Neotoma collection types.
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/apps/taxaindatasets:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/taxaInDatasets'
          description: A list of all taxa in neotoma and the datasets in which they are found.
      tags:
        - Taxonomic metadata
        - v2.0
  /v2.0/data/chronologies/{chronid}:
    get:
      description: Returns the chronology and chronological controls used for a dataset age model associated with a particular chronology ID.
      parameters:
        - $ref: '#/components/parameters/chronidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chronologyv2_0'
          description: A Neotoma chronology object.
      summary: Chronology metadata.
      tags:
        - Chronology metadata
        - v2.0
  /v2.0/data/contacts:
    get:
      description: Returns researcher contact information associated with a record.
      parameters:
        - $ref: '#/components/parameters/contactidQuery'
        - $ref: '#/components/parameters/familyNameQuery'
        - $ref: '#/components/parameters/contactNameQuery'
        - $ref: '#/components/parameters/contactStatusQuery'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contactresponse'
          description: contact
      summary: Contact information for Neotoma contributors.
      tags:
        - Contact metadata
        - v2.0
  /v2.0/data/contacts/{contactid}:
    get:
      description: Returns contact information for an individaul in the database.
      parameters:
        - $ref: '#/components/parameters/contactidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contactresponse'
          description: A Neotoma contacts object.
      summary: Contact information for an individual
      tags:
        - Contact metadata
        - v2.0
  /v2.0/data/contacts/{contactid}/sites:
    get:
      description: Returns the set of sites associated with an individual (or individuals).
      parameters:
        - $ref: '#/components/parameters/contactidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sitesv2response'
          description: A Neotoma sites object.
      summary: Site information for all sites by an individual
      tags:
        - Site metadata
        - v2.0
  /v2.0/data/datasets:
    get:
      description: Returns information about Neotoma dataset
      parameters:
        - $ref: '#/components/parameters/sitenameQuery'
        - $ref: '#/components/parameters/databaseQuery'
        - $ref: '#/components/parameters/datasettypeQuery'
        - $ref: '#/components/parameters/altMinQuery'
        - $ref: '#/components/parameters/altMaxQuery'
        - $ref: '#/components/parameters/locQuery'
        - $ref: '#/components/parameters/siteidQuery'
        - $ref: '#/components/parameters/datasetidQuery'
        - $ref: '#/components/parameters/doiQuery'
        - $ref: '#/components/parameters/gpidQuery'
        - $ref: '#/components/parameters/keywordQuery'
        - $ref: '#/components/parameters/contactidQuery'
        - $ref: '#/components/parameters/taxaQuery'
        - $ref: '#/components/parameters/ageYoungQuery'
        - $ref: '#/components/parameters/ageOldQuery'
        - $ref: '#/components/parameters/ageOfQuery'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetv2'
          description: An array of datasets.
      summary: Dataset information.
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/data/datasets/db:
    get:
      description: Returns datasets associated with a specific constituent database in Neotoma.
      parameters:
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
        - $ref: '#/components/parameters/databaseQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetv2'
          description: Datasets
      summary: Datasets associated with a Neotoma database.
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/data/datasets/{datasetid}:
    get:
      description: Returns information about Neotoma dataset
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataset'
          description: An array of datasets.
      summary: Dataset information.
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/data/datasets/{datasetid}/chronologies:
    get:
      description: Returns the set of chronologies associated with a dataset.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chronologyv2response'
          description: chronology
      summary: Chronology information for a record
      tags:
        - Chronology metadata
        - v2.0
  /v2.0/data/datasets/{datasetid}/contacts:
    get:
      description: Returns researcher contact information associated with a record.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contact'
          description: contact
      summary: Contact information for Neotoma contributors.
      tags:
        - Contact metadata
        - v2.0
  /v2.0/data/datasets/{datasetid}/doi:
    get:
      description: Returns Digital Object Identifiers associated with specific datasets.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/doiresponse'
          description: DOI
      summary: DOI and associated metadata for a dataset.
      tags:
        - DOI metadata
        - v2.0
  /v2.0/data/datasets/{datasetid}/lithology:
    get:
      description: Returns the lithology associated with specific datasets.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lithologyresponse'
          description: Lithology
      summary: Lithology metadata for a dataset.
      tags:
        - Lithology metadata
        - v2.0
  /v2.0/data/datasets/{datasetid}/publications:
    get:
      description: Returns publications data associated with specific datasets.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicationsresponse'
          description: Publication
      summary: Publication and associated metadata for a dataset.
      tags:
        - Publication metadata
        - v2.0
  /v2.0/data/datasets/{datasetid}/sites:
    get:
      description: Returns site data associated with specific datasets.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sitesv2response'
          description: Site
      summary: Site metadata for a dataset.
      tags:
        - Site metadata
        - v2.0
  /v2.0/data/datasets/{datasetid}/taxa:
    get:
      description: Returns the set of taxa associated with a specific dataset.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/taxonresponse'
          description: Taxa
      summary: Taxon metadata for a dataset.
      tags:
        - Taxonomic metadata
        - v2.0
  /v2.0/data/datasets_elc:
    get:
      description: Returns the dataset information based on a dataset ID for the ELC API.
      parameters:
        - $ref: '#/components/parameters/siteidQuery'
        - $ref: '#/components/parameters/contactidQuery'
        - $ref: '#/components/parameters/datasettypeQuery'
        - $ref: '#/components/parameters/altMinQuery'
        - $ref: '#/components/parameters/altMaxQuery'
        - $ref: '#/components/parameters/locQuery'
        - $ref: '#/components/parameters/ageYoungQuery'
        - $ref: '#/components/parameters/ageOldQuery'
        - $ref: '#/components/parameters/ageOfQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetselcresponse'
          description: A Neotoma datasets object suitable for the EarthLife Consortium API.
      summary: Site information for all sites by an individual
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/data/datasets_elc/{datasetid}:
    get:
      description: Returns the dataset information based on a dataset ID for the ELC API.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetselcresponse'
          description: A Neotoma datasets object suitable for the EarthLife Consortium API.
      summary: Site information for all sites by an individual
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/data/dbtables:
    get:
      description: |
        Returns the named Neotoma Database table.  An empty query will return a list of tables.
      parameters:
        - $ref: '#/components/parameters/tableQuery'
        - $ref: '#/components/parameters/countQuery'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dbtablenameresponse'
          description: Returned table.
      summary: Returns the full content of a named Neotoma Database table.
      tags:
        - Database tables
        - v2.0
  /v2.0/data/dbtables/{table}:
    get:
      description: |
        Returns the named Neotoma Database table.  An empty query will return a list of tables. Uses a default limit of 25 and offset of 0.
      parameters:
        - $ref: '#/components/parameters/tablePath'
        - $ref: '#/components/parameters/countQuery'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dbtables'
          description: Returned table.
      summary: Returns the full content of a named Neotoma Database table.
      tags:
        - Database tables
        - v2.0
  /v2.0/data/downloads/{datasetid}:
    get:
      description: Returns the named Neotoma Database table.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/downloadv2'
          description: Returned download object.
      summary: Returns the named Neotoma data record.
      tags:
        - Data download
        - v2.0
  /v2.0/data/frozen/{datasetid}:
    get:
      description: Returns the full metadata for a Neotoma record as it was when the DOI was minted.
      parameters:
        - $ref: '#/components/parameters/datasetidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/downloadv2'
          description: Returned download object.
      summary: Returns the named Neotoma data record.
      tags:
        - Data download
        - v2.0
  /v2.0/data/geopoliticalunits:
    get:
      parameters:
        - $ref: '#/components/parameters/gpidQuery'
        - $ref: '#/components/parameters/gpnameQuery'
        - $ref: '#/components/parameters/rankQuery'
        - $ref: '#/components/parameters/lowergpQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/geopolitical'
          description: An array of geopolitical units.
      summary: Returns information about geopolitical units.
      tags:
        - Geopolitical metadata
        - v2.0
  /v2.0/data/geopoliticalunits/{gpid}:
    get:
      parameters:
        - $ref: '#/components/parameters/gpidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/geopolitical'
          description: An array of geopolitical units.
      summary: Returns information about geopolitical units.
      tags:
        - Geopolitical metadata
        - v2.0
  /v2.0/data/geopoliticalunits/{gpid}/datasets:
    get:
      parameters:
        - $ref: '#/components/parameters/gpidPath'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetv2'
          description: An array of datasets.
      summary: Returns information about datasets based on the geopolitical unit in which they occur.
      tags:
        - Site metadata
        - v2.0
  /v2.0/data/geopoliticalunits/{gpid}/sites:
    get:
      parameters:
        - $ref: '#/components/parameters/gpidPath'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sitesv2response'
          description: An array of sites.
      summary: Returns information about sites based on the geopolitical unit in which they occur.
      tags:
        - Site metadata
        - v2.0
  /v2.0/data/occurrences:
    get:
      description: Returns occurrence information for a particular taxon, geographic region or temporal slice.
      parameters:
        - $ref: '#/components/parameters/taxonNameQuery'
        - $ref: '#/components/parameters/taxonidQuery'
        - $ref: '#/components/parameters/siteidQuery'
        - $ref: '#/components/parameters/sitenameQuery'
        - $ref: '#/components/parameters/datasettypeQuery'
        - $ref: '#/components/parameters/altMinQuery'
        - $ref: '#/components/parameters/altMaxQuery'
        - $ref: '#/components/parameters/locQuery'
        - $ref: '#/components/parameters/ageOfQuery'
        - $ref: '#/components/parameters/ageYoungQuery'
        - $ref: '#/components/parameters/ageOldQuery'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/occurrence'
          description: occurrence
      summary: Individual occurrence records for Neotoma records.
      tags:
        - Occurrence metadata
        - v2.0
  /v2.0/data/occurrences/{occurrenceid}:
    get:
      description: Returns occurrence information for a particular taxon, geographic region or temporal slice.
      parameters:
        - $ref: '#/components/parameters/occurrenceidPath'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/occurrence'
          description: occurrence
      summary: Individual occurrence records for Neotoma records.
      tags:
        - Occurrence metadata
        - v2.0
  /v2.0/data/pollen:
    get:
      parameters:
        - $ref: '#/components/parameters/taxonNameQuery'
        - $ref: '#/components/parameters/taxonidQuery'
        - $ref: '#/components/parameters/siteidQuery'
        - $ref: '#/components/parameters/sitenameQuery'
        - $ref: '#/components/parameters/datasettypeQuery'
        - $ref: '#/components/parameters/altMinQuery'
        - $ref: '#/components/parameters/altMaxQuery'
        - $ref: '#/components/parameters/locQuery'
        - $ref: '#/components/parameters/ageOfQuery'
        - $ref: '#/components/parameters/ageYoungQuery'
        - $ref: '#/components/parameters/ageOldQuery'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pollenresponse'
          description: A record of all pollen samples in time/space for a particular taxon.
      tags:
        - Pollen
        - v2.0
  /v2.0/data/pollen/{id}:
    get:
      parameters:
        - $ref: '#/components/parameters/pollenidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pollenresponse'
          description: A record of all pollen samples in time/space for a particular taxon.
      tags:
        - Pollen
        - v2.0
  /v2.0/data/publications:
    get:
      description: Returns information about Neotoma publications
      parameters:
        - $ref: '#/components/parameters/publicationidQuery'
        - $ref: '#/components/parameters/datasetidQuery'
        - $ref: '#/components/parameters/siteidQuery'
        - $ref: '#/components/parameters/familyNameQuery'
        - $ref: '#/components/parameters/pubtypeQuery'
        - $ref: '#/components/parameters/pubyearQuery'
        - $ref: '#/components/parameters/pubsearchQuery'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publications'
          description: A list of publications.
      summary: Returns information about Neotoma publications
      tags:
        - Publication metadata
        - v2.0
  /v2.0/data/publications/{publicationid}:
    get:
      description: Returns information about Neotoma publications
      parameters:
        - $ref: '#/components/parameters/publicationidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publications'
          description: A list of publications.
      summary: Returns information about Neotoma publications
      tags:
        - Publication metadata
        - v2.0
  /v2.0/data/sites:
    get:
      description: Returns information about Neotoma sites
      parameters:
        - $ref: '#/components/parameters/sitenameQuery'
        - $ref: '#/components/parameters/databaseQuery'
        - $ref: '#/components/parameters/datasettypeQuery'
        - $ref: '#/components/parameters/altMinQuery'
        - $ref: '#/components/parameters/altMaxQuery'
        - $ref: '#/components/parameters/locQuery'
        - $ref: '#/components/parameters/siteidQuery'
        - $ref: '#/components/parameters/datasetidQuery'
        - $ref: '#/components/parameters/doiQuery'
        - $ref: '#/components/parameters/gpidQuery'
        - $ref: '#/components/parameters/keywordQuery'
        - $ref: '#/components/parameters/contactidQuery'
        - $ref: '#/components/parameters/taxaQuery'
        - $ref: '#/components/parameters/ageYoungQuery'
        - $ref: '#/components/parameters/ageOldQuery'
        - $ref: '#/components/parameters/ageOfQuery'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sitesv2response'
          description: An array of sites.
      summary: Site information.
      tags:
        - Site metadata
        - v2.0
  /v2.0/data/sites/{siteid}:
    get:
      description: Returns information about Neotoma sites.
      parameters:
        - $ref: '#/components/parameters/siteidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sitesv2'
          description: An array of sites.
      summary: Site information.
      tags:
        - Site metadata
        - v2.0
  /v2.0/data/sites/{siteid}/chronologies:
    get:
      description: Given a Neotoma siteid, return all associated chronologies.
      parameters:
        - $ref: '#/components/parameters/siteidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chronologyv2response'
          description: chronology
      summary: Chronology information for Neotoma sites.
      tags:
        - Chronology metadata
        - v2.0
  /v2.0/data/sites/{siteid}/contacts:
    get:
      description: Given a Neotoma siteid, return all associated contacts.
      parameters:
        - $ref: '#/components/parameters/siteidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contactfromsite'
          description: contact
      summary: Contact information for Neotoma contributors based on a known Neotoma site.
      tags:
        - Contact metadata
        - v2.0
  /v2.0/data/sites/{siteid}/datasets:
    get:
      description: Returns information about Neotoma dataset
      parameters:
        - $ref: '#/components/parameters/siteidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataset'
          description: An array of datasets.
      summary: Dataset information.
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/data/sites/{siteid}/datasets_elc:
    get:
      description: Returns information about Neotoma dataset, formatted for the EarthLifeConsortium
      parameters:
        - $ref: '#/components/parameters/siteidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetelcresponse'
          description: An array of datasets.
      summary: Dataset information.
      tags:
        - Dataset metadata
        - v2.0
  /v2.0/data/sites/{siteid}/geopoliticalunits:
    get:
      parameters:
        - $ref: '#/components/parameters/siteidPath'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/geopolitical'
          description: An array of geopolitical units.
      summary: Returns information about geopolitical units.
      tags:
        - Geopolitical metadata
        - v2.0
  /v2.0/data/summary/dsdbmonth:
    get:
      description: Returns summary statistics for the database as a whole, broken down by constituent database.
      parameters:
        - description: The starting month (from present == 0) for which to generate the summary.
          example: 0
          in: query
          name: start
          required: true
          schema:
            default: 0
            maximum: 9999
            minimum: 0
            type: integer
        - description: The ending month (from present == 0) for which to generate the summary.
          example: 1
          in: query
          name: end
          required: true
          schema:
            default: 1
            maximum: 9999
            minimum: 0
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/summarydatabase'
          description: A count of the datasets added by database for the requested period.
      summary: Summary Information
      tags:
        - Summary Information
        - v2.0
  /v2.0/data/summary/dstypemonth:
    get:
      description: Returns summary statistics for the database as a whole, broken down by dataset type.
      parameters:
        - description: The starting month (from present == 0) for which to generate the summary.
          example: 0
          in: query
          name: start
          required: true
          schema:
            default: 0
            type: integer
        - description: The ending month (from present == 0) for which to generate the summary.
          example: 1
          in: query
          name: end
          required: true
          schema:
            default: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/summarydatatype'
          description: A count of the datasets added by datasettype for the requested period.
      summary: Summary Information
      tags:
        - Summary Information
        - v2.0
  /v2.0/data/summary/rawbymonth:
    get:
      description: Returns the count of sites, datasets, publications and other objects added to Neotoma during the requested time period.
      parameters:
        - description: The starting month (from present == 0) for which to generate the summary.
          example: 0
          in: query
          name: start
          required: true
          schema:
            default: 0
            type: integer
        - description: The ending month (from present == 0) for which to generate the summary.
          example: 1
          in: query
          name: end
          required: true
          schema:
            default: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/summaryalldata'
          description: A count of the data objects added to Neotoma.
      summary: Summary Information
      tags:
        - Summary Information
        - v2.0
  /v2.0/data/taxa:
    get:
      description: Returns information about a taxon and (if requested) related taxa.
      parameters:
        - $ref: '#/components/parameters/taxonNameQuery'
        - $ref: '#/components/parameters/taxaGroupQuery'
        - $ref: '#/components/parameters/ecolGroupQuery'
        - $ref: '#/components/parameters/taxastatusQuery'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/taxa'
          description: A taxon or array of taxa.
      summary: Taxonomic information.
      tags:
        - Taxonomic metadata
        - v2.0
  /v2.0/data/taxa/{taxonid}:
    get:
      description: Returns information about a taxon and (if requested) related taxa.
      parameters:
        - $ref: '#/components/parameters/taxonidPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/taxonresponse'
          description: A taxon or array of taxa.
      summary: Taxonomic information.
      tags:
        - Taxonomic metadata
        - v2.0
  /v2.0/data/taxa/{taxonid}/occurrences:
    get:
      description: Returns occurrence information for a particular taxon, geographic region or temporal slice.
      parameters:
        - $ref: '#/components/parameters/taxonidPath'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/occurrence'
          description: occurrence
      summary: Individual occurrence records for Neotoma records.
      tags:
        - Occurrence metadata
        - v2.0
servers:
  - description: Neotoma production server.
    url: https://api.neotomadb.org/
  - description: Neotoma development server.
    url: https://api-dev.neotomadb.org/
  - description: Local Neotoma server.
    url: http://localhost:3001/
tags:
  - description: Endpoints that access tables from Neotoma verbatim.
    externalDocs:
      url: https://open.neotomadb.org/dbschema/ndb/index.html
    name: Database tables
  - description: Information about chronological controls and the models used to add the temporal component to records.
    externalDocs:
      url: https://open.neotomadb.org/manual/neotoma-tables.html#chronology-age-related-tables
    name: Chronology metadata
  - description: Information about Neotoma data contributors, authors and data analysts.
    externalDocs:
      url: https://open.neotomadb.org/manual/neotoma-tables.html#individual-related-tables
    name: Contact metadata
  - description: Information about site location and metadata specific to the individual dataset.
    externalDocs:
      url: https://open.neotomadb.org/manual/neotoma-tables.html#dataset-collection-related-tables
    name: Dataset metadata
  - description: Full dataset download, including all sample data for a particular dataset.
    externalDocs:
      url: https://open.neotomadb.org/manual/neotoma-tables.html#sample-related-tables
    name: Data download
  - description: Information about the geopolitical units in which a site is located.
    externalDocs:
      url: https://open.neotomadb.org/manual/neotoma-tables.html#site-related-tables
    name: Geopolitical metadata
  - description: A simplified data return, similar to the data download, but specific to a particular taxon, time or location.
    name: Occurrence metadata
  - description: For ease of use in online applications, pre-calculated pollen percentages for taxa, location or temporal bins.
    name: Pollen proportions
  - description: Formatted publication data related to Neotoma records.
    externalDocs:
      url: https://open.neotomadb.org/manual/neotoma-tables.html#publication-related-tables
    name: Publication metadata
  - description: All metadata associated with a particular site with fossil records.
    externalDocs:
      url: https://open.neotomadb.org/manual/neotoma-tables.html#site-related-tables
    name: Site metadata
  - description: All available information about a particular taxon.
    externalDocs:
      url: https://open.neotomadb.org/manual/neotoma-tables.html#taxonomy-related-tables
    name: Taxonomic metadata
  - description: Summary statistics for the database as a whole.
    name: Summary Information
  - description: All API endpoints associated with v1.5 of the Neotoma API.
    externalDocs:
      url: http://github.com/NeotomaDB/api_nodetest
    name: v1.5
  - description: All API endpoints associated with v2.0 of the Neotoma API.
    externalDocs:
      url: http://github.com/NeotomaDB/api_nodetest
    name: v2.0