IDigBio API v0 Specification: Difference between revisions
Jump to navigation
Jump to search
(add bold note) |
(add v0 features list) |
||
Line 70: | Line 70: | ||
| returns a recordset with specific entity ID | | 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: | |||
<pre> | |||
http://api.idigbio.org/v1 | |||
</pre> | |||
Parameters: None | |||
Sample Usage: | |||
<pre> | |||
$ 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" | |||
} | |||
</pre> |
Revision as of 11:44, 14 May 2014
This document has been superceded by IDigBio API v1 Specification. Please use the current version of the API if possible.
Previous versions of the API (such as v0) may be less-fully documented than current versions.
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}"
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" }