1,554
edits
IDigBio API v1 Specification: Difference between revisions
cleanup
(convert "entity" to "item" and "collection" to "list" but probably missed some) |
(cleanup) |
||
| Line 75: | Line 75: | ||
;Description | ;Description | ||
:Returns a list of top-level API feature types for a particular version of the API | :Returns a list of top-level API feature types for a particular version of the API. | ||
;Resource URL | ;Resource URL | ||
| Line 230: | Line 230: | ||
;Description | ;Description | ||
:Returns the full Media Record matching the specified iDigBio UUID. The iDigBio UUID is represented by the "idigbio:uuid" data field. A Media Record contains metadata about an image. | :Returns the full Media Record matching the specified iDigBio UUID. The iDigBio UUID is represented by the "idigbio:uuid" data field. A Media Record contains metadata and relationship information about media (typically an image). | ||
;Resource URL | ;Resource URL | ||
| Line 451: | Line 451: | ||
;Description | ;Description | ||
:Returns a full Specimen Record matching the specified iDigBio UUID. The iDigBio UUID is represented by the "idigbio:uuid" data field. | :Returns a full Specimen Record matching the specified iDigBio UUID. The iDigBio UUID is represented by the "idigbio:uuid" data field. A Specimen Record contains occurrence data. | ||
| Line 794: | Line 794: | ||
;Description | ;Description | ||
:Returns a list of recordset | :Returns a list of recordset iDigBio UUIDs. A recordset is a group of published data. | ||
;Resource URL | ;Resource URL | ||
| Line 811: | Line 811: | ||
|limit | |limit | ||
|0, 1, 2, ..., 10, ..., n | |0, 1, 2, ..., 10, ..., n | ||
|Controls the number of | |Controls the number of items returned. | ||
|- | |- | ||
|offset | |offset | ||
|0, 1, 2, ..., 10, ..., n | |0, 1, 2, ..., 10, ..., n | ||
|Controls the starting | |Controls the starting offset for paging through the API. | ||
|} | |} | ||
;Sample Usage | ;Sample Usage | ||
Request 3 | Request a List of recordset iDigBio UUIDs (and in this usage example, limit the number of results to 3): | ||
<pre> | <pre> | ||
| Line 879: | Line 879: | ||
;Description | ;Description | ||
:Returns the full record | :Returns the full record of a recordset with the specified iDigBio UUID. | ||
;Resource URL | ;Resource URL | ||