1,554
edits
IDigBio API v1 Specification: Difference between revisions
clarify nextpage prevpage →GET /v1/mediarecords
(clarify nextpage prevpage →GET /v1/records) |
(clarify nextpage prevpage →GET /v1/mediarecords) |
||
| Line 113: | Line 113: | ||
;Description | ;Description | ||
:Returns a collection (list) of Media Record | :Returns a collection (list) of Media Record entities. | ||
;Resource URL | ;Resource URL | ||
| Line 130: | Line 130: | ||
|limit | |limit | ||
|0, 1, 2, 10, ..., 100, ..., 1000, ..., n | |0, 1, 2, 10, ..., 100, ..., 1000, ..., n | ||
|Controls the number of | |Controls the number of entities returned by a collection url. Large values may cause HTTP requests to time out. Recommended values are from 1 to 1000. | ||
|- | |- | ||
|offset | |offset | ||
| Line 201: | Line 201: | ||
Of interest here is that <code> "idigbio:itemCount" </code> contains the number of items of this type in the API. In this case, we have 2,342,880 mediarecords total. | Of interest here is that <code> "idigbio:itemCount" </code> contains the number of items of this type in the API. In this case, we have 2,342,880 mediarecords total. | ||
A link to the next | |||
The next "page" of records can be requested by adding the "offset" paramenter. | |||
A link that includes the offset to the next page is provided in the results: | |||
<pre> | <pre> | ||
| Line 209: | Line 212: | ||
</pre> | </pre> | ||
Request the next 5 entity ids starting at offset 5. | |||
<pre> | <pre> | ||
| Line 276: | Line 279: | ||
</pre> | </pre> | ||
With current results starting at offset 5 and a limit of 5, the previous page and a next page offsets are 0 and 10 respectively (offset +- limit). | |||
''DO NOT expect to be able to page through the entire iDigBio data this way. See [[iDigBio API Performance]] if you find yourself trying to page through large amounts of data.'' | ''DO NOT expect to be able to page through the entire iDigBio data this way. See [[iDigBio API Performance]] if you find yourself trying to page through large amounts of data.'' | ||