IDigBio API v1 Specification: Difference between revisions
(add Descriptions and stub out sample results) |
(add Parameters) |
||
| Line 18: | Line 18: | ||
http://api.idigbio.org/v1/mediarecords | http://api.idigbio.org/v1/mediarecords | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample Result: | Sample Result: | ||
| Line 34: | Line 39: | ||
http://api.idigbio.org/v1/mediarecords/{ID} | http://api.idigbio.org/v1/mediarecords/{ID} | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample Result: | Sample Result: | ||
| Line 50: | Line 59: | ||
http://api.idigbio.org/v1/mediarecords/{ID}/media | http://api.idigbio.org/v1/mediarecords/{ID}/media | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample Result: | Sample Result: | ||
| Line 67: | Line 80: | ||
http://api.idigbio.org/v1/records | http://api.idigbio.org/v1/records | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample Result: | Sample Result: | ||
| Line 83: | Line 101: | ||
http://api.idigbio.org/v1/records/{ID} | http://api.idigbio.org/v1/records/{ID} | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample result: | Sample result: | ||
| Line 98: | Line 121: | ||
http://api.idigbio.org/v1/records/{ID}/media | http://api.idigbio.org/v1/records/{ID}/media | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample result: | Sample result: | ||
| Line 114: | Line 142: | ||
http://api.idigbio.org/v1/publishers | http://api.idigbio.org/v1/publishers | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample result: | Sample result: | ||
| Line 130: | Line 163: | ||
http://api.idigbio.org/v1/publishers/{ID} | http://api.idigbio.org/v1/publishers/{ID} | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample result: | Sample result: | ||
| Line 146: | Line 184: | ||
http://api.idigbio.org/v1/recordsets | http://api.idigbio.org/v1/recordsets | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample result: | Sample result: | ||
| Line 162: | Line 205: | ||
http://api.idigbio.org/v1/recordsets/{ID} | http://api.idigbio.org/v1/recordsets/{ID} | ||
</pre> | </pre> | ||
Parameters: | |||
* something goes here | |||
Sample result: | Sample result: | ||
Revision as of 15:52, 13 May 2014
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
Parameters:
- something goes here
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}
Parameters:
- something goes here
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
Parameters:
- something goes here
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
Parameters:
- something goes here
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}
Parameters:
- something goes here
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
Parameters:
- something goes here
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
Parameters:
- something goes here
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}
Parameters:
- something goes here
Sample result:
# CURL SOMETHING
GET /{api_version}/recordsets
Description: Returns a collection of recordset IDs
Resource URL:
http://api.idigbio.org/v1/recordsets
Parameters:
- something goes here
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}
Parameters:
- something goes here
Sample result:
# CURL SOMETHING