iDigBio / idb-us-collections

MIT License
4 stars 4 forks source link

Build Status

iDigBio: US Collections

iDigBio publishes a list of US Collections, via the iDigBio Portal, that is intended to be a comprehensive list of all natural history collections in the United States of America. This GitHub project provides an administrative interface for managing the publishing of this list and offers tools to those who would like to use these data programmatically.

API Endpoint

Published collections JSON Endpoint

Setup

see setup.md

Project Structure

Collections should each have their own JSON file, named by their collection UUID, and be formatted similar to this:

{
    "institution": "Yale University, Peabody Museum of Natural History",
    "collection": "Vertebrate Paleontology",
    "recordsets": "0220907a-0463-4ae0-8a0b-77f5e80fff40",
    "recordsetQuery": "{\"recordset\":\"0220907a-0463-4ae0-8a0b-77f5e80fff40\"}",
    "institution_code": "YPM",
    "collection_code": "",
    "collection_uuid": "urn:uuid:3ebe7bbc-2f1b-4c34-b83e-1ae349d7ffb6",
    "collection_lsid": "",
    "collection_url": "http://peabody.yale.edu/collections/vertebrate-paleontology",
    "collection_catalog_url": "http://peabody.yale.edu/collections/search-collections?vp",
    "description": "",
    "descriptionForSpecialists": "",
    "cataloguedSpecimens": null,
    "knownToContainTypes": null,
    "taxonCoverage": "",
    "geographic_range": "",
    "collectionExtent": "",
    "contact": "Christopher Norris",
    "contact_role": "Senior Collections Manager",
    "contact_email": "christopher.norris@yale.edu",
    "mailing_address": "Yale University, PO Box 208118",
    "mailing_city": "New Haven",
    "mailing_state": "Connecticut",
    "mailing_zip": "06511-0000",
    "physical_address": "170-210 Whitney Avenue",
    "physical_city": "New Haven",
    "physical_state": "Connecticut",
    "physical_zip": "06511-0000",
    "UniqueNameUUID": "",
    "attributionLogoURL": "",
    "providerManagedID": "",
    "derivedFrom": "",
    "sameAs": "",
    "flags": "",
    "portalDisplay": "",
    "lat": 41.3167,
    "lon": -72.9204
  }

Metadata

Stub records

Stub records can be generated using the function r createCollStub . A stub record will be generated and added to a directory called "stubs". These stub records will have UUID's and can be moved to the "collections" directory once they have been updated or are complete.

{
    "institution": "",
    "collection": "",
    "recordsets": "",
    "recordsetQuery": "",
    "institution_code": "",
    "collection_code": "",
    "collection_uuid": "",
    "collection_lsid": "",
    "collection_url": "",
    "collection_catalog_url": "",
    "description": "",
    "descriptionForSpecialists": "",
    "cataloguedSpecimens": null,
    "knownToContainTypes": null,
    "taxonCoverage": "",
    "geographic_range": "",
    "collectionExtent": "",
    "contact": "",
    "contact_role": "",
    "contact_email": "",
    "mailing_address": "",
    "mailing_city": "",
    "mailing_state": "",
    "mailing_zip": "",
    "physical_address": "",
    "physical_city": "",
    "physical_state": "",
    "physical_zip": "",
    "UniqueNameUUID": "",
    "attributionLogoURL": "",
    "providerManagedID": "",
    "derivedFrom": "",
    "sameAs": "",
    "flags": "",
    "portalDisplay": "",
    "lat": null,
    "lon": null
  }