IDigBio API v1 Specification: Difference between revisions

wording change to entities →‎GET /v1/records
(make identical to mediarecords parameters and add sample →‎GET /v1/records)
(wording change to entities →‎GET /v1/records)
Line 345: Line 345:


;Description
;Description
:Returns a collection (list) of Specimen Record IDs
:Returns a collection (list) of Specimen Record entities


;Resource URL
;Resource URL
Line 371: Line 371:
;Sample Usage
;Sample Usage


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


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


Request the next 5 items starting at offset 5:
Request the next 5 entities starting at offset 5:


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


We now have a previous page and a next page, with the offsets of 0 and 10 respectively.
We now have links to a previous page and a next page, with the offsets of 0 and 10 respectively.


''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