Skip to content

Additional Examples

Jump to bottom Edit New page
Dan Stoner edited this page Jul 11, 2018 · 9 revisions

Additional Questions and Answers and Howtos regarding the search API

Q: How do I search for 'NSF_TCN' in dwc:dynamicProperties?

There are at least two possible methods.

  1. Using the iDigBio search API directly:

https://search.idigbio.org/v2/search/records/?rq={"data.dwc:dynamicProperties":"nsf_tcn"}&limit=1

The same url, with proper url-encoding of special characters:

https://search.idigbio.org/v2/search/records/?rq=%7B%22data.dwc:dynamicProperties%22%3A+%22nsf_tcn%22%7D&limit=1

At the time this example was created, we found 104340 records that contain 'nsf_tcn' in dynamicProperties.

The itemCount field returns the number of records that matched the query, regardless of whether the results are constrained by the limit parameter.

Results of above query look like the following (truncated for brevity) when fetched using HTTPie:

$ http 'https://search.idigbio.org/v2/search/records/?rq={"data.dwc:dynamicProperties":"nsf_tcn"}&limit=1'
{
  "itemCount": 104340,
  "items": [
    {
      "data": {
        "dcterms:language": "en",
        "dcterms:license": "https://creativecommons.org/publicdomain/zero/1.0/",
        "dcterms:modified": "2018-03-14 12:27:59",
        "dcterms:references": "http://www.burkemuseum.org/collections/search/result.php?GUID=UWBM:InvertebratePaleontology:66079",
        "dcterms:rightsHolder": "University of Washington Burke Museum",
        "dcterms:type": "PhysicalObject",
        "dwc:Identification": [
          {
            "coreid": "urn:catalog:UWBM:InvertebratePaleontology:66079",
            "dwc:class": "Gastropoda",
            "dwc:family": "Buccinidae",
            "dwc:genus": "Parvisipho",
            "dwc:higherClassification": "Mollusca; Gastropoda; Neogastropoda; Buccinidae",
            "dwc:nomenclaturalCode": "ICZN",
            "dwc:order": "Neogastropoda",
            "dwc:phylum": "Mollusca",
            "dwc:scientificName": "Parvisipho lewisiana (Weaver), 1912",
            "dwc:scientificNameAuthorship": "(Weaver), 1912",
            "dwc:specificEpithet": "lewisiana",
            "dwc:taxonRank": "species"
          }
        ],
        "dwc:basisOfRecord": "FossilSpecimen",
        "dwc:catalogNumber": "66079",
        "dwc:class": "Gastropoda",
        "dwc:collectionCode": "Invertebrate Paleontology",
        "dwc:continent": "North America",
        "dwc:coordinateUncertaintyInMeters": "5566",
        "dwc:country": "United States",
        "dwc:county": "Lewis",
        "dwc:dataGeneralizations": "Latitude and longitude reduced in precision by 0.1 degrees.",
        "dwc:decimalLatitude": "46.45",
        "dwc:decimalLongitude": "-122.95",
        "dwc:dynamicProperties": "{\"NSF_TCN\":\"EPICC\",\"Elements\":\"conch;cone\",\"CollectingParty\":\"David Nunnallee\"}",
        "dwc:earliestEpochOrLowestSeries": "Eocene",
        "dwc:earliestEraOrLowestErathem": "Cenozoic",
        "dwc:earliestPeriodOrLowestSystem": "Paleogene",
        "dwc:eventDate": "1967-00-00",
        "dwc:family": "Buccinidae",
        "dwc:fieldNumber": "25, 28",
        "dwc:formation": "Cowlitz",
        "dwc:genus": "Parvisipho",
        "dwc:geodeticDatum": "WGS 84",
        "dwc:georeferenceSources": "GEOLocate",
        "dwc:georeferencedBy": "Hindle, Sawyer",
        "dwc:georeferencedDate": "2017-04-17 14:39:21",
        "dwc:higherClassification": "Mollusca; Gastropoda; Neogastropoda; Buccinidae",
        "dwc:higherGeography": "North America; United States; Washington; Lewis County",
        "dwc:highestBiostratigraphicZone": "Narizian",
        "dwc:individualCount": "3",
        "dwc:informationWithheld": "Precise coordinates and locality withheld to protect sensitive information.",
        "dwc:institutionCode": "UWBM",
        "dwc:institutionID": "http://biocol.org/urn:lsid:biocol.org:col:34878",
        "dwc:latestEpochOrHighestSeries": "Eocene",
        "dwc:latestEraOrHighestErathem": "Cenozoic",
        "dwc:latestPeriodOrHighestSystem": "Paleogene",
        "dwc:locality": "[redacted]",
        "dwc:locationID": "A9522",
        "dwc:lowestBiostratigraphicZone": "Narizian",
        "dwc:nomenclaturalCode": "ICZN",
        "dwc:occurrenceID": "urn:catalog:UWBM:InvertebratePaleontology:66079",
        "dwc:occurrenceRemarks": "2 complete one with bore hole, one apex missing, one siphon missing  Nunnallee Locality 28 = A9522-2.",
        "dwc:order": "Neogastropoda",
        "dwc:otherCatalogNumbers": "Accession: 1988-11, Other numbers: W659",
        "dwc:ownerInstitutionCode": "UWBM",
        "dwc:phylum": "Mollusca",
        "dwc:recordNumber": "586, 724",
        "dwc:recordedBy": "David Nunnallee",
        "dwc:scientificName": "Parvisipho lewisiana (Weaver), 1912",
        "dwc:scientificNameAuthorship": "(Weaver), 1912",
        "dwc:specificEpithet": "lewisiana",
        "dwc:stateProvince": "Washington",
        "dwc:taxonRank": "species",
        "dwc:verbatimEventDate": "1967-1970",
        "dwc:year": "1967",
        "id": "urn:catalog:UWBM:InvertebratePaleontology:66079"
      },
      "etag": "b8cd7ff265fdc9cc8cc36efbc1874dd8fa45934c",
      "type": "records",
      "uuid": "061594f4-69a3-41ff-9396-dac55cc8409b"
    }
  ],
  "lastModified": "2018-06-04T09:35:41.809Z"
}

If you wanted to download the records bundled in an archive you could use that same query with the Download API.

https://www.idigbio.org/wiki/index.php/IDigBio_Download_API

  1. Using a client library, such as the iDigBio R client, a similar query can be created by using the examples at the following link (replace "parasite" with "nsf_tcn").

https://rdrr.io/cran/ridigbio/man/idig_search_records.html

Q: How do I search for content in dwc:datasetName?

TBD

Add a custom footer
Add a custom sidebar
Clone this wiki locally