1,554
edits
IDigBio API v1 Specification: Difference between revisions
convert sections to use dl and indented li
(convert section to use dl and indented li) |
(convert sections to use dl and indented li) |
||
| 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 83: | Line 82: | ||
=== GET /v1/aggregates === | === GET /v1/aggregates === | ||
Deprecated, do not use. | ;Description | ||
:Deprecated, do not use. | |||
---- | ---- | ||
=== GET /v1/mediaaps === | === GET /v1/mediaaps === | ||
Deprecated, do not use. | ;Description | ||
:Deprecated, do not use. | |||
---- | ---- | ||
| Line 139: | Line 140: | ||
=== GET /v1/mediarecords/{ID}/media === | === 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 | |||
Resource URL | ;Resource URL | ||
<pre> | <pre> | ||
| Line 147: | Line 149: | ||
</pre> | </pre> | ||
Parameters | ;Parameters | ||
* something goes here | * something goes here | ||
Sample Usage | ;Sample Usage | ||
<pre> | <pre> | ||
| Line 160: | Line 162: | ||
=== GET /v1/records === | === GET /v1/records === | ||
Description: Returns a collection of record IDs | ;Description | ||
:Returns a collection of record IDs | |||
Resource URL | ;Resource URL | ||
<pre> | <pre> | ||
| Line 168: | Line 171: | ||
</pre> | </pre> | ||
;Parameters | |||
Parameters | |||
* something goes here | * something goes here | ||
Sample Usage | ;Sample Usage | ||
<pre> | <pre> | ||
| Line 182: | Line 184: | ||
=== GET /v1/records/{ID} === | === GET /v1/records/{ID} === | ||
Description: Returns a record with the specific entity ID | ;Description | ||
:Returns a record with the specific entity ID | |||
Resource URL | ;Resource URL | ||
<pre> | <pre> | ||
| Line 190: | Line 193: | ||
</pre> | </pre> | ||
;Parameters | |||
Parameters | |||
* something goes here | * something goes here | ||
Sample Usage | ;Sample Usage | ||
<pre> | <pre> | ||
# CURL SOMETHING | # CURL SOMETHING | ||
| Line 203: | Line 205: | ||
=== GET /v1/records/{ID}/media === | === 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 | |||
Resource URL | ;Resource URL | ||
<pre> | <pre> | ||
| Line 211: | Line 214: | ||
</pre> | </pre> | ||
;Parameters | |||
Parameters | |||
* something goes here | * something goes here | ||
Sample Usage | ;Sample Usage | ||
<pre> | <pre> | ||
| Line 225: | Line 227: | ||
=== GET /v1/publishers === | === GET /v1/publishers === | ||
Description: Returns a collection of publisher IDs | ;Description | ||
:Returns a collection of publisher IDs | |||
Resource URL | ;Resource URL | ||
<pre> | <pre> | ||
| Line 234: | Line 237: | ||
Parameters | ;Parameters | ||
* something goes here | * something goes here | ||
Sample Usage | ;Sample Usage | ||
<pre> | <pre> | ||
| Line 247: | Line 250: | ||
=== GET /v1/organizations === | === GET /v1/organizations === | ||
Deprecated, do not use. | ;Description | ||
:Deprecated, do not use. | |||
---- | ---- | ||
=== GET /v1/people === | === GET /v1/people === | ||
Deprecated, do not use. | ;Description: | ||
:Deprecated, do not use. | |||
---- | ---- | ||
=== GET /v1/publishers/{ID} === | === GET /v1/publishers/{ID} === | ||
Description: Returns a publisher with specific entity ID | ;Description | ||
:Returns a publisher with specific entity ID | |||
Resource URL | ;Resource URL | ||
<pre> | <pre> | ||
| Line 265: | Line 271: | ||
</pre> | </pre> | ||
;Parameters | |||
Parameters | |||
* something goes here | * something goes here | ||
Sample Usage | ;Sample Usage | ||
<pre> | <pre> | ||
| Line 279: | Line 284: | ||
=== GET /v1/recordsets === | === GET /v1/recordsets === | ||
Description: Returns a collection of recordset IDs | ;Description | ||
:Returns a collection of recordset IDs | |||
Resource URL | ;Resource URL | ||
<pre> | <pre> | ||
| Line 287: | Line 293: | ||
</pre> | </pre> | ||
;Parameters | |||
Parameters | |||
* something goes here | * something goes here | ||
Sample Usage | ;Sample Usage | ||
<pre> | <pre> | ||
| Line 301: | Line 306: | ||
=== GET /v1/recordsets/{ID} === | === GET /v1/recordsets/{ID} === | ||
Description: Returns a recordset with specific entity ID | ;Description | ||
:Returns a recordset with specific entity ID | |||
Resource URL | ;Resource URL | ||
<pre> | <pre> | ||
| Line 309: | Line 315: | ||
</pre> | </pre> | ||
;Parameters | |||
Parameters | |||
* something goes here | * something goes here | ||
Sample Usage | ;Sample Usage | ||
<pre> | <pre> | ||
| Line 323: | Line 328: | ||
=== GET /v1/taxa === | === GET /v1/taxa === | ||
Deprecated, do not use. | ;Description | ||
:Deprecated, do not use. | |||
---- | |||
== Search == | == Search == | ||