1,554
edits
IDigBio API v1 Specification: Difference between revisions
Jump to navigation
Jump to search
add hr before each endpoint and other minor edits
(→Search) |
(add hr before each endpoint and other minor edits) |
||
| Line 20: | Line 20: | ||
Additional usage examples beyond those provided in this document, including more information on the "curl" command, are available in [[iDigBio API Examples]]. | Additional usage examples beyond those provided in this document, including more information on the "curl" command, are available in [[iDigBio API Examples]]. | ||
---- | |||
=== GET / === | === GET / === | ||
| Line 42: | Line 43: | ||
</pre> | </pre> | ||
---- | |||
=== GET /{api_version} === | === GET /{api_version} === | ||
Description: Returns a list of top-level API feature types for a particular version of the API | ;Description | ||
:Returns a list of top-level API feature types for a particular version of the API | |||
Resource URL | ;Resource URL | ||
<pre> | <pre> | ||
http://api.idigbio.org/v1 | http://api.idigbio.org/v1 | ||
</pre> | </pre> | ||
Parameters: None | ;Parameters | ||
:None | |||
;Sample Usage | |||
<pre> | <pre> | ||
$ curl -s http://api.idigbio.org/v1 | json_pp | $ curl -s http://api.idigbio.org/v1 | json_pp | ||
| Line 71: | Line 75: | ||
</pre> | </pre> | ||
Notes: | ;Notes | ||
:Some of the listed feature types may deprecated. This will be noted elsewhere in the API specification document. | |||
---- | |||
=== GET /v1/aggregates === | === GET /v1/aggregates === | ||
Deprecated, do not use. | Deprecated, do not use. | ||
---- | |||
=== GET /v1/mediaaps === | === GET /v1/mediaaps === | ||
Deprecated, do not use. | Deprecated, do not use. | ||
---- | |||
=== GET /v1/mediarecords === | === GET /v1/mediarecords === | ||
| Line 101: | Line 109: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/mediarecords/{ID} === | === GET /v1/mediarecords/{ID} === | ||
| Line 121: | Line 130: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/mediarecords/{ID}/media === | === GET /v1/mediarecords/{ID}/media === | ||
| Line 141: | Line 151: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/records === | === GET /v1/records === | ||
| Line 163: | Line 173: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/records/{ID} === | === GET /v1/records/{ID} === | ||
| Line 183: | Line 194: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/records/{ID}/media === | === GET /v1/records/{ID}/media === | ||
| Line 204: | Line 216: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/publishers === | === GET /v1/publishers === | ||
| Line 225: | Line 238: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/organizations === | === GET /v1/organizations === | ||
Deprecated, do not use. | Deprecated, do not use. | ||
---- | |||
=== GET /v1/people === | === GET /v1/people === | ||
Deprecated, do not use. | Deprecated, do not use. | ||
---- | |||
=== GET /v1/publishers/{ID} === | === GET /v1/publishers/{ID} === | ||
| Line 254: | Line 270: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/recordsets === | === GET /v1/recordsets === | ||
| Line 275: | Line 292: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/recordsets/{ID} === | === GET /v1/recordsets/{ID} === | ||
| Line 296: | Line 314: | ||
</pre> | </pre> | ||
---- | |||
=== GET /v1/taxa === | === GET /v1/taxa === | ||