IDigBio API v1 Specification: Difference between revisions

From iDigBio
Jump to navigation Jump to search
(stub)
Line 10: Line 10:
== Endpoints ==
== Endpoints ==


=== '/mediarecords' ===
=== GET /{api_version}/mediarecords ===


Resource URL
Resource URL
Line 17: Line 17:
</pre>
</pre>


=== '/mediarecords/{ID}' ===
Sample Result:
 
=== GET /{api_version}/mediarecords/{ID}  ===


Resource URL:
Resource URL:
Line 23: Line 25:
<pre>
<pre>
http://api.idigbio.org/v1/mediarecords/{ID}
http://api.idigbio.org/v1/mediarecords/{ID}
</pre>
Sample Result:
=== GET /{api_version}/mediarecords/{ID}/media ===
Resource URL:
<pre>
http://api.idigbio.org/v1/mediarecords/{ID}/media
</pre>
Sample Result:
=== GET /{api_version}/records ===
Resource URL:
<pre>
http://api.idigbio.org/v1/
</pre>
=== GET /{api_version}/records/{ID} ===
Resource URL:
<pre>
http://api.idigbio.org/v1/
</pre>
=== GET /{api_version}/records/{ID}/media ===
Resource URL:
<pre>
http://api.idigbio.org/v1/records/{ID}/media
</pre>
=== GET /{api_version}/publishers ===
Resource URL:
<pre>
http://api.idigbio.org/v1/publishers
</pre>
=== GET /{api_version}/publishers/{ID} ===
Resource URL:
<pre>
http://api.idigbio.org/v1/
</pre>
=== GET /{api_version}/recordsets ===
Resource URL:
<pre>
http://api.idigbio.org/v1/
</pre>
=== GET /{api_version}/recordsets/{ID} ===
Resource URL:
<pre>
http://api.idigbio.org/v1/recordsets/{ID}
</pre>
</pre>

Revision as of 16:26, 13 May 2014


API Version Information

This is the specification for v1 of the iDigBio API. Previous versions of the API continue to exist but should be considered deprecated. API users should use the current version of the API. This document supercedes iDigBio API v0 Specification.


Endpoints

GET /{api_version}/mediarecords

Resource URL

http://api.idigbio.org/v1/mediarecords

Sample Result:

GET /{api_version}/mediarecords/{ID}

Resource URL:

http://api.idigbio.org/v1/mediarecords/{ID}

Sample Result:

GET /{api_version}/mediarecords/{ID}/media

Resource URL:

http://api.idigbio.org/v1/mediarecords/{ID}/media

Sample Result:


GET /{api_version}/records

Resource URL:

http://api.idigbio.org/v1/

GET /{api_version}/records/{ID}

Resource URL:

http://api.idigbio.org/v1/

GET /{api_version}/records/{ID}/media

Resource URL:

http://api.idigbio.org/v1/records/{ID}/media

GET /{api_version}/publishers

Resource URL:

http://api.idigbio.org/v1/publishers

GET /{api_version}/publishers/{ID}

Resource URL:

http://api.idigbio.org/v1/


GET /{api_version}/recordsets

Resource URL:

http://api.idigbio.org/v1/

GET /{api_version}/recordsets/{ID}

Resource URL:

http://api.idigbio.org/v1/recordsets/{ID}