IDigBio API v1 Specification: Difference between revisions

add recommended sizes →‎GET /v1/mediarecords
(add recommended sizes →‎GET /v1/mediarecords)
Line 129: Line 129:
|-
|-
|limit
|limit
|
|0, 1, 2, ... n
|Controls the number of records returned by a collection url. Large values may cause HTTP requests to time out.
|Controls the number of records returned by a collection url. Large values may cause HTTP requests to time out. Recommended values are from 1 to 1000.
|-
|-
|offset
|offset
|
|0, 1, 2, ..., n
|Controls the starting entity offset for paging through the API. Large offsets are extremely inefficient, so combinations of small limits and large offsets may cause requests to fail.
|Controls the starting entity offset for paging through the API. Large offsets, greater than 1000000 (1 million) are extremely inefficient, so combinations of small limits and large offsets may cause requests to fail.
|}
|}
;Sample Usage
;Sample Usage


1,554

edits