1,554
edits
IDigBio API v1 Specification: Difference between revisions
Jump to navigation
Jump to search
populate recordsets section →GET /v1/recordsets
(populate recordsets section →GET /v1/recordsets) |
|||
| Line 843: | Line 843: | ||
;Description | ;Description | ||
:Returns a collection of recordset | :Returns a collection of recordset entities. | ||
;Resource URL | ;Resource URL | ||
| Line 853: | Line 853: | ||
;Optional Parameters | ;Optional Parameters | ||
{| class="wikitable" style="background-color: #ffffcc;" width="100%" | |||
!parameter | |||
!valid values | |||
!detailed description | |||
|- | |||
|limit | |||
|0, 1, 2, ..., 10, ..., n | |||
|Controls the number of entities returned. | |||
|- | |||
|offset | |||
|0, 1, 2, ..., 10, ..., n | |||
|Controls the starting entity offset for paging through the API. | |||
|} | |||
;Sample Usage | ;Sample Usage | ||
Request 3 recordset entities: | |||
<pre> | <pre> | ||
$ curl -s http://api.idigbio.org/v1/recordsets?limit=3 | json_pp | |||
{ | |||
"idigbio:errors" : [], | |||
"idigbio:links" : { | |||
"idigbio:nextPage" : "http://api.idigbio.org/v1/recordsets?limit=3&offset=3" | |||
}, | |||
"idigbio:items" : [ | |||
{ | |||
"idigbio:links" : { | |||
"recordset" : "http://api.idigbio.org/v1/recordsets/0072bf11-a354-4998-8730-c0cb4cfc9517" | |||
}, | |||
"idigbio:uuid" : "0072bf11-a354-4998-8730-c0cb4cfc9517", | |||
"idigbio:version" : 2, | |||
"idigbio:etag" : "c6df1d0673b5452af4118caf96c5c066b498e095", | |||
"idigbio:dateModified" : "2014-04-18T17:54:38.751Z" | |||
}, | |||
{ | |||
"idigbio:links" : { | |||
"recordset" : "http://api.idigbio.org/v1/recordsets/00d9fcc1-c8e2-4ef6-be64-9994ca6a32c3" | |||
}, | |||
"idigbio:uuid" : "00d9fcc1-c8e2-4ef6-be64-9994ca6a32c3", | |||
"idigbio:version" : 3, | |||
"idigbio:etag" : "3d3c08b1155db3353048648fae23d05ca52e3a24", | |||
"idigbio:dateModified" : "2014-04-18T17:54:32.657Z" | |||
}, | |||
{ | |||
"idigbio:links" : { | |||
"recordset" : "http://api.idigbio.org/v1/recordsets/02fceae6-c71c-4db9-8b2f-e235ced6624a" | |||
}, | |||
"idigbio:uuid" : "02fceae6-c71c-4db9-8b2f-e235ced6624a", | |||
"idigbio:version" : 2, | |||
"idigbio:etag" : "28b6a174e77f4f81f22dbf9b463a89d3b6b479a9", | |||
"idigbio:dateModified" : "2014-04-18T17:54:50.955Z" | |||
} | |||
], | |||
"idigbio:itemCount" : "255" | |||
} | |||
</pre> | </pre> | ||