IDigBio API v1 Specification: Difference between revisions

clarify nextpage prevpage →‎GET /v1/records
(clarify nextpage prevpage →‎GET /v1/records)
Line 371: Line 371:
;Sample Usage
;Sample Usage


Request 5 specimen record entities:
Request 5 specimen record entity ids:


<pre>
<pre>
Line 444: Line 444:
</pre>
</pre>


Request the next 5 entities starting at offset 5:
Request the next 5 entity ids starting at offset 5:


<pre>
<pre>
Line 513: Line 513:
</pre>
</pre>


We now have links to a previous page and a next page, with the offsets of 0 and 10 respectively.
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.''
1,554

edits