1,554
edits
IDigBio API v1 Specification: Difference between revisions
Jump to navigation
Jump to search
add deprecated types and change api_version to actual version
(update to v1 response) |
(add deprecated types and change api_version to actual version) |
||
| Line 46: | Line 46: | ||
=== GET /{api_version} === | === GET /{api_version} === | ||
Description: Returns a list of top-level API feature types | Description: Returns a list of top-level API feature types for a particular version of the API | ||
Resource URL: | Resource URL: | ||
| Line 72: | Line 72: | ||
</pre> | </pre> | ||
Notes: Some of the features listed may be experimental, deprecated, or have no valid data behind them. | Notes: Some of the features listed above may be experimental, deprecated, or have no valid data behind them. | ||
=== GET / | === GET /v1/aggregates === | ||
Deprecated, do not use. | |||
=== GET /v1/mediaaps === | |||
Deprecated, do not use. | |||
=== GET /v1/mediarecords === | |||
Description: Returns a collection of Media Record IDs | Description: Returns a collection of Media Record IDs | ||
| Line 94: | Line 102: | ||
</pre> | </pre> | ||
=== GET / | === GET /v1/mediarecords/{ID} === | ||
Description: Returns a Media Record with the specific entity ID | Description: Returns a Media Record with the specific entity ID | ||
| Line 114: | Line 122: | ||
</pre> | </pre> | ||
=== GET / | === GET /v1/mediarecords/{ID}/media === | ||
Description: Returns an image file (JPEG) associated with the specific entity ID | Description: Returns an image file (JPEG) associated with the specific entity ID | ||
| Line 135: | Line 143: | ||
=== GET / | === GET /v1/records === | ||
Description: Returns a collection of record IDs | Description: Returns a collection of record IDs | ||
| Line 156: | Line 164: | ||
</pre> | </pre> | ||
=== GET / | === GET /v1/records/{ID} === | ||
Description: Returns a record with the specific entity ID | Description: Returns a record with the specific entity ID | ||
| Line 176: | Line 184: | ||
</pre> | </pre> | ||
=== GET / | === GET /v1/records/{ID}/media === | ||
Description: Returns an image (JPEG) associated with the specific entity ID | Description: Returns an image (JPEG) associated with the specific entity ID | ||
| Line 197: | Line 205: | ||
</pre> | </pre> | ||
=== GET / | === GET /v1/publishers === | ||
Description: Returns a collection of publisher IDs | Description: Returns a collection of publisher IDs | ||
| Line 218: | Line 226: | ||
</pre> | </pre> | ||
=== GET / | === GET /v1/organizations === | ||
Deprecated, do not use. | |||
=== GET /v1/people === | |||
Deprecated, do not use. | |||
=== GET /v1/publishers/{ID} === | |||
Description: Returns a publisher with specific entity ID | Description: Returns a publisher with specific entity ID | ||
| Line 239: | Line 255: | ||
</pre> | </pre> | ||
=== GET / | === GET /v1/recordsets === | ||
Description: Returns a collection of recordset IDs | Description: Returns a collection of recordset IDs | ||
| Line 260: | Line 276: | ||
</pre> | </pre> | ||
=== GET / | === GET /v1/recordsets/{ID} === | ||
Description: Returns a recordset with specific entity ID | Description: Returns a recordset with specific entity ID | ||
| Line 280: | Line 296: | ||
# CURL SOMETHING | # CURL SOMETHING | ||
</pre> | </pre> | ||
=== GET /v1/taxa === | |||
Deprecated, do not use. | |||
== Search == | == Search == | ||