1,554
edits
IDigBio API v1 Specification: Difference between revisions
→Endpoints
(→Search) |
|||
| Line 10: | Line 10: | ||
== Endpoints == | == Endpoints == | ||
Additional usage examples are available in [[iDigBio API Examples]]. | Unless otherwise noted, successful responses from the API will return a JSON-formatted document. | ||
Additional usage examples beyond those provided in this document, including more information on the "curl" command, are available in [[iDigBio API Examples]]. | |||
=== GET / === | |||
Description: Returns a list of top-level api_version or service URLs | |||
Resource URL: | |||
<pre> | |||
http://api.idigbio.org/ | |||
</pre> | |||
Parameters: None | |||
Sample Usage: | |||
<pre> | |||
$ curl -s http://api.idigbio.org/ | json_pp | |||
{ | |||
"v1" : "http://api.idigbio.org/v1/", | |||
"check" : "http://api.idigbio.org/check", | |||
"v0" : "http://api.idigbio.org/v0/" | |||
} | |||
</pre> | |||
=== GET /{api_version}/mediarecords === | === GET /{api_version}/mediarecords === | ||
| Line 26: | Line 50: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||
| Line 46: | Line 70: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||
| Line 66: | Line 90: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||
| Line 88: | Line 112: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||
| Line 109: | Line 133: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||
# CURL SOMETHING | # CURL SOMETHING | ||
| Line 129: | Line 153: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||
| Line 150: | Line 174: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||
| Line 171: | Line 195: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||
| Line 192: | Line 216: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||
| Line 213: | Line 237: | ||
* something goes here | * something goes here | ||
Sample | Sample Usage: | ||
<pre> | <pre> | ||