IDigBio API v0 Specification

Caution:

The iDigBio version 0 API is superceded by the IDigBio API v1 Specification and the iDigBio API v2 / iDigBio Search API specification. API users should migrate to using the most recent version of the API. This page remains for historical reference.

Available Types

$ curl -s "http://api.idigbio.org/v0/" | json_pp
{
   "records" : "http://api.idigbio.org/v0/records",
   "recordsets" : "http://api.idigbio.org/v0/recordsets",
   "mediaaps" : "http://api.idigbio.org/v0/mediaaps",
   "mediarecords" : "http://api.idigbio.org/v0/mediarecords"
}

Available endpoints

All endpoints follow the form of "http://api.idigbio.org/{api_version}{endpoint}"

iDigBio v0 API Endpoints

Endpoint	Method	Description
'/mediarecords'	GET	returns a collection of media record IDs
'/mediarecords/{ID}'	GET	returns a media record with the specific entity ID
'/mediarecords/{ID}/media'	GET	returns an image associated with the specific entity ID
'/records'	GET	returns a collection of record IDs
'/records/{ID}'	GET	returns a record with the specific entity ID
'/records/{ID}/media'	GET	returns an image associated with the specific entity ID
'/publishers'	GET	returns a collection of publisher IDs
'/publishers/{ID}'	GET	returns a publisher with specific entity ID
'/recordsets'	GET	returns a collection of recordset IDs
'/recordsets/{ID}'	GET	returns a recordset with specific entity ID

GET /{api_version}

Description: Returns a list of top-level API feature types for a particular version of the API

Resource URL:

http://api.idigbio.org/v1

Parameters: None

Sample Usage:

$ curl -s http://api.idigbio.org/v0 | json_pp
{
   "records" : "http://api.idigbio.org/v0/records",
   "recordsets" : "http://api.idigbio.org/v0/recordsets",
   "mediaaps" : "http://api.idigbio.org/v0/mediaaps",
   "mediarecords" : "http://api.idigbio.org/v0/mediarecords"
}