1,554
edits
IDigBio API v1 Specification: Difference between revisions
add Descriptions and stub out sample results
(add missing urls) |
(add Descriptions and stub out sample results) |
||
| Line 5: | Line 5: | ||
== API Version Information == | == 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 | 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]]. | ||
| Line 12: | Line 12: | ||
=== GET /{api_version}/mediarecords === | === GET /{api_version}/mediarecords === | ||
Resource URL | Description: Returns a collection of Media Record IDs | ||
Resource URL: | |||
<pre> | <pre> | ||
http://api.idigbio.org/v1/mediarecords | http://api.idigbio.org/v1/mediarecords | ||
| Line 18: | Line 20: | ||
Sample Result: | Sample Result: | ||
<pre> | |||
# CURL SOMETHING | |||
</pre> | |||
=== GET /{api_version}/mediarecords/{ID} === | === GET /{api_version}/mediarecords/{ID} === | ||
Description: Returns a Media Record with the specific entity ID | |||
Resource URL: | Resource URL: | ||
| Line 28: | Line 36: | ||
Sample Result: | Sample Result: | ||
<pre> | |||
# CURL SOMETHING | |||
</pre> | |||
=== GET /{api_version}/mediarecords/{ID}/media === | === GET /{api_version}/mediarecords/{ID}/media === | ||
Description: Returns an image file (JPEG) associated with the specific entity ID | |||
Resource URL: | Resource URL: | ||
| Line 38: | Line 52: | ||
Sample Result: | Sample Result: | ||
<pre> | |||
# CURL SOMETHING with -L to follow redirects | |||
</pre> | |||
=== GET /{api_version}/records === | === GET /{api_version}/records === | ||
Description: Returns a collection of record IDs | |||
Resource URL: | Resource URL: | ||
| Line 46: | Line 66: | ||
<pre> | <pre> | ||
http://api.idigbio.org/v1/records | http://api.idigbio.org/v1/records | ||
</pre> | |||
Sample Result: | |||
<pre> | |||
# CURL SOMETHING | |||
</pre> | </pre> | ||
=== GET /{api_version}/records/{ID} === | === GET /{api_version}/records/{ID} === | ||
Description: Returns a record with the specific entity ID | |||
Resource URL: | Resource URL: | ||
| Line 54: | Line 82: | ||
<pre> | <pre> | ||
http://api.idigbio.org/v1/records/{ID} | http://api.idigbio.org/v1/records/{ID} | ||
</pre> | |||
Sample result: | |||
<pre> | |||
# CURL SOMETHING | |||
</pre> | </pre> | ||
=== GET /{api_version}/records/{ID}/media === | === GET /{api_version}/records/{ID}/media === | ||
Description: Returns an image (JPEG) associated with the specific entity ID | |||
Resource URL: | Resource URL: | ||
| Line 62: | Line 97: | ||
<pre> | <pre> | ||
http://api.idigbio.org/v1/records/{ID}/media | http://api.idigbio.org/v1/records/{ID}/media | ||
</pre> | |||
Sample result: | |||
<pre> | |||
# CURL SOMETHING with -L to watch redirects | |||
</pre> | </pre> | ||
=== GET /{api_version}/publishers === | === GET /{api_version}/publishers === | ||
Description: Returns a collection of publisher IDs | |||
Resource URL: | Resource URL: | ||
<pre> | <pre> | ||
http://api.idigbio.org/v1/publishers | http://api.idigbio.org/v1/publishers | ||
</pre> | |||
Sample result: | |||
<pre> | |||
# CURL SOMETHING | |||
</pre> | </pre> | ||
=== GET /{api_version}/publishers/{ID} === | === GET /{api_version}/publishers/{ID} === | ||
Description: Returns a publisher with specific entity ID | |||
Resource URL: | Resource URL: | ||
| Line 79: | Line 131: | ||
</pre> | </pre> | ||
Sample result: | |||
<pre> | |||
# CURL SOMETHING | |||
</pre> | |||
=== GET /{api_version}/recordsets === | === GET /{api_version}/recordsets === | ||
Description: Returns a collection of recordset IDs | |||
Resource URL: | Resource URL: | ||
<pre> | <pre> | ||
http://api.idigbio.org/v1/recordsets | http://api.idigbio.org/v1/recordsets | ||
</pre> | |||
Sample result: | |||
<pre> | |||
# CURL SOMETHING | |||
</pre> | </pre> | ||
=== GET /{api_version}/recordsets/{ID} === | === GET /{api_version}/recordsets/{ID} === | ||
Description: Returns a recordset with specific entity ID | |||
Resource URL: | Resource URL: | ||
| Line 93: | Line 161: | ||
<pre> | <pre> | ||
http://api.idigbio.org/v1/recordsets/{ID} | http://api.idigbio.org/v1/recordsets/{ID} | ||
</pre> | |||
Sample result: | |||
<pre> | |||
# CURL SOMETHING | |||
</pre> | </pre> | ||