IDigBio API v1 Specification

API Version Information

This is the specification for v1 of the iDigBio API. Previous versions of the API continue to exist but should be considered deprecated. API users should migrate to using the current version of the API. This document supercedes iDigBio API v0 Specification.

Endpoints

GET /{api_version}/mediarecords

Description: Returns a collection of Media Record IDs

Resource URL:

http://api.idigbio.org/v1/mediarecords

Sample Result:

# CURL SOMETHING

GET /{api_version}/mediarecords/{ID}

Description: Returns a Media Record with the specific entity ID

Resource URL:

http://api.idigbio.org/v1/mediarecords/{ID}

Sample Result:

# CURL SOMETHING

GET /{api_version}/mediarecords/{ID}/media

Description: Returns an image file (JPEG) associated with the specific entity ID

Resource URL:

http://api.idigbio.org/v1/mediarecords/{ID}/media

Sample Result:

# CURL SOMETHING with -L to follow redirects

GET /{api_version}/records

Description: Returns a collection of record IDs

Resource URL:

http://api.idigbio.org/v1/records

Sample Result:

# CURL SOMETHING

GET /{api_version}/records/{ID}

Description: Returns a record with the specific entity ID

Resource URL:

http://api.idigbio.org/v1/records/{ID}

Sample result:

# CURL SOMETHING

GET /{api_version}/records/{ID}/media

Description: Returns an image (JPEG) associated with the specific entity ID

Resource URL:

http://api.idigbio.org/v1/records/{ID}/media

Sample result:

# CURL SOMETHING with -L to watch redirects

GET /{api_version}/publishers

Description: Returns a collection of publisher IDs

Resource URL:

http://api.idigbio.org/v1/publishers

Sample result:

# CURL SOMETHING

GET /{api_version}/publishers/{ID}

Description: Returns a publisher with specific entity ID

Resource URL:

http://api.idigbio.org/v1/publishers/{ID}

Sample result:

# CURL SOMETHING

GET /{api_version}/recordsets

Description: Returns a collection of recordset IDs

Resource URL:

http://api.idigbio.org/v1/recordsets

Sample result:

# CURL SOMETHING

GET /{api_version}/recordsets/{ID}

Description: Returns a recordset with specific entity ID

Resource URL:

http://api.idigbio.org/v1/recordsets/{ID}

Sample result:

# CURL SOMETHING