1,554
edits
IDigBio API v1 Examples: Difference between revisions
move section
(change screenshot to "records" type →Display a thumbnail image for a mediarecord) |
(move section) |
||
| Line 675: | Line 675: | ||
</pre> | </pre> | ||
=== Fetch an Older Version of a Particular | === Fetch an Older Version of a Particular Record === | ||
Consider an iDigBio Media Record "idigbio:uuid" : "ff5fd841-6bc6-4241-80d3-def7e1b6d5e8" that has been updated over time so there are multiple revisions of the record. The API shows that the current version of this particular record is version 1. | Consider an iDigBio Media Record "idigbio:uuid" : "ff5fd841-6bc6-4241-80d3-def7e1b6d5e8" that has been updated over time so there are multiple revisions of the record. The API shows that the current version of this particular record is version 1. | ||
| Line 684: | Line 684: | ||
</pre> | </pre> | ||
We would like to look at the previous version (version 0) to see what has changed | We would like to look at the previous version (version 0) to see what has changed. We do this by adding <code>?version=0</code> as a parameter to the URL. | ||
<pre> | <pre> | ||
| Line 692: | Line 692: | ||
The "version" parameter is available for any endpoint that returns a single entity record (as opposed to a List). | The "version" parameter is available for any endpoint that returns a single entity record (as opposed to a List). | ||
=== Paging through the API === | === Paging through the API === | ||
| Line 914: | Line 839: | ||
;TO DO One more paging to help differentiate these multiples of 5. | ;TO DO One more paging to help differentiate these multiples of 5. | ||
=== Fetch a list of five MediaRecord IDs === | |||
The "mediarecords" endpoint returns a List of Media Record IDs. | |||
Example URL: | |||
http://api.idigbio.org/v1/mediarecords?limit=5&offset=5 | |||
Example Results: | |||
<pre> | |||
$ curl -s "http://api.idigbio.org/v1/mediarecords?limit=5&offset=5" | json_pp | |||
{ | |||
"idigbio:errors" : [], | |||
"idigbio:links" : { | |||
"idigbio:nextPage" : "http://api.idigbio.org/v1/mediarecords?limit=5&offset=10", | |||
"idigbio:prevPage" : "http://api.idigbio.org/v1/mediarecords?limit=5&offset=0" | |||
}, | |||
"idigbio:items" : [ | |||
{ | |||
"idigbio:links" : { | |||
"mediarecord" : "http://api.idigbio.org/v1/mediarecords/00001478-c150-4faf-a617-439a838d4377" | |||
}, | |||
"idigbio:uuid" : "00001478-c150-4faf-a617-439a838d4377", | |||
"idigbio:version" : 1, | |||
"idigbio:etag" : "30f602e4eb47ebb2ceb265f64217e3cf5664f517", | |||
"idigbio:dateModified" : "2014-03-21T23:09:39.752Z" | |||
}, | |||
{ | |||
"idigbio:links" : { | |||
"mediarecord" : "http://api.idigbio.org/v1/mediarecords/00001a91-189b-4002-b56e-a770a55951a0" | |||
}, | |||
"idigbio:uuid" : "00001a91-189b-4002-b56e-a770a55951a0", | |||
"idigbio:version" : 0, | |||
"idigbio:etag" : "647e82d17ee435fb14f0f8607dabe88dfc3a1944", | |||
"idigbio:dateModified" : "2014-04-25T04:49:32.359Z" | |||
}, | |||
{ | |||
"idigbio:links" : { | |||
"mediarecord" : "http://api.idigbio.org/v1/mediarecords/00002091-4fb3-410a-9307-bd3e917dfcca" | |||
}, | |||
"idigbio:uuid" : "00002091-4fb3-410a-9307-bd3e917dfcca", | |||
"idigbio:version" : 0, | |||
"idigbio:etag" : "90d98d48d9e7e07eab9064bd9b6e22ce6502c07f", | |||
"idigbio:dateModified" : "2014-05-03T18:45:47.112Z" | |||
}, | |||
{ | |||
"idigbio:links" : { | |||
"mediarecord" : "http://api.idigbio.org/v1/mediarecords/00002c32-ae3a-41ed-9bd9-f6c50d3e35fb" | |||
}, | |||
"idigbio:uuid" : "00002c32-ae3a-41ed-9bd9-f6c50d3e35fb", | |||
"idigbio:version" : 3, | |||
"idigbio:etag" : "d1ded90d06e93876b1badd01222905add93e8806", | |||
"idigbio:dateModified" : "2014-04-19T00:25:59.471Z" | |||
}, | |||
{ | |||
"idigbio:links" : { | |||
"mediarecord" : "http://api.idigbio.org/v1/mediarecords/00002dbd-6415-463b-8cae-38f548415ffa" | |||
}, | |||
"idigbio:uuid" : "00002dbd-6415-463b-8cae-38f548415ffa", | |||
"idigbio:version" : 2, | |||
"idigbio:etag" : "4e298045b496146f5c51e331c9887fd7afde4deb", | |||
"idigbio:dateModified" : "2014-04-21T20:29:39.531Z" | |||
} | |||
], | |||
"idigbio:itemCount" : "2342880" | |||
} | |||
</pre> | |||
Screenshot of Results: | |||
[[File:Screenshot_jsonview_idigbio_api_mediarecords_limit_offset.png]] | |||
=== Display a thumbnail image for a specimen record === | === Display a thumbnail image for a specimen record === | ||