iDigBio

IDigBio API v1 Specification: Difference between revisions

Page Discussion

IDigBio API v1 Specification (view source)

Revision as of 15:13, 23 May 2014

201 bytes added ,  23 May 2014
convert "entity" to "item" and "collection" to "list" but probably missed some
(convert "entity" to "item" and "collection" to "list" but probably missed some)
Line 124: Line 124:


;Description
;Description
:Returns a List of Media Record items.
:Returns a List of Media Record iDigBio UUIDs. The iDigBio UUID is represented by the "idigbio:uuid" data field.


;Resource URL
;Resource URL
Line 141: Line 141:
|limit
|limit
|0, 1, 2, 10, ..., 100, ..., 1000, ..., n
|0, 1, 2, 10, ..., 100, ..., 1000, ..., n
|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.
|Controls the number of items returned in the List. Large values may cause HTTP requests to time out. Recommended values are from 1 to 1000.
|-
|-
|offset
|offset
|0, 1, 2, ... 1000, ..., 10000, ..., n
|0, 1, 2, ... 1000, ..., 10000, ..., n
|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.
|Controls the starting 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


Request 5 media record entities:
Request five media record items:


<pre>
<pre>
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 about an image.


;Resource URL
;Resource URL
Line 344: Line 344:


;Description
;Description
:Returns a List of Specimen Record entities
:Returns a List of Specimen Record iDigBio UUIDs. The iDigBio UUID is represented by the "idigbio:uuid" data field.


;Resource URL
;Resource URL
Line 361: Line 361:
|limit
|limit
|0, 1, 2, 10, ..., 100, ..., 1000, ..., n
|0, 1, 2, 10, ..., 100, ..., 1000, ..., n
|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.   
|Controls the number of items returned. Large values may cause HTTP requests to time out. Recommended values are from 1 to 1000.   
|-
|-
|offset
|offset
|0, 1, 2, ... 1000, ..., 10000, ..., n
|0, 1, 2, ... 1000, ..., 10000, ..., n
|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.  
|Controls the starting 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


Request 5 specimen record entity ids:
Request five specimen record items:


<pre>
<pre>
Line 451: Line 451:


;Description
;Description
:Returns a Specimen Record matching the specific 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.




Line 563: Line 563:
|quality
|quality
|"thumbnail" "webview"
|"thumbnail" "webview"
|Specifiy the quality of the image returned from the API. Omitting quality will return the full-size high quality original image from source provider. The values "thumbnail" and "webview" return images of width 260 and 600 pixels respectively.
|Specifiy the quality of the image returned from the API. Omitting quality will return the full-size high quality original image. The values "thumbnail" and "webview" return images of width 260 and 600 pixels respectively.
|}
|}


Line 603: Line 603:


;Description
;Description
:Returns a collection (list) of publisher entities.
:Returns a List of Publisher iDigBio UUIDs. Publishers are the top-level entities containing metadata about data publishing locations.


;Resource URL
;Resource URL
Line 621: Line 621:
|limit
|limit
|0, 1, 2, ..., 10, ..., n
|0, 1, 2, ..., 10, ..., n
|Controls the number of entities returned.
|Controls the number of items returned.
|-
|-
|offset
|offset
|0, 1, 2, ..., 10, ..., n
|0, 1, 2, ..., 10, ..., n
|Controls the starting entity offset for paging through the API.
|Controls the starting offset for paging through the API.
|}
|}


;Sample Usage
;Sample Usage


Retrieve a list with only one publisher entity.
Retrieve a List with only one publisher entity.


<pre>
<pre>
Line 671: Line 671:


;Description
;Description
:Returns a full Publisher record that matches the specified iDigBio UUID. A publisher record includes links to all of the recordsets provided to iDigBio by the publisher as well as other information.
:Returns a full Publisher Record that matches the specified iDigBio UUID. A publisher record includes links to all of the recordsets provided to iDigBio by the publisher as well as other information.


;Resource URL
;Resource URL
Line 794: Line 794:


;Description
;Description
:Returns a list of recordset entities.
:Returns a list of recordset items. A recordset is a group of published data.


;Resource URL
;Resource URL
Line 958: Line 958:


;Description
;Description
:Returns a list of mediarecord IDs that belong to the particular recordset of the specified iDigBio UUID
:Returns a list of Media Record iDigBio UUIDs that belong to the recordset of the specified iDigBio UUID.


;Resource URL
;Resource URL
Line 975: Line 975:
|limit
|limit
|0, 1, 2, 10, ..., 100, ..., 1000, ..., n
|0, 1, 2, 10, ..., 100, ..., 1000, ..., n
|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.
|Controls the number of items returned. Large values may cause HTTP requests to time out. Recommended values are from 1 to 1000.
|-
|-
|offset
|offset
|0, 1, 2, ... 100, ..., 1000, ..., n
|0, 1, 2, ... 100, ..., 1000, ..., n
|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.
|Controls the starting 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


Return a list with a single mediarecord that belongs to a particular recordset.
Return a List of mediarecord iDigBio UUIDs that belong to a particular recordset (and in this usage example, limit the number of results to 1):


<pre>
<pre>
Line 1,024: Line 1,024:


;Description
;Description
:Returns a list of record IDs that belong to the recordset of the specified entity ID
:Returns a List of iDigBio UUIDs that belong to the recordset of the specified entity ID.


;Resource URL
;Resource URL
Line 1,041: Line 1,041:
|limit
|limit
|0, 1, 2, 10, ..., 100, ..., 1000, ..., n
|0, 1, 2, 10, ..., 100, ..., 1000, ..., n
|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.   
|Controls the number of items returned. Large values may cause HTTP requests to time out. Recommended values are from 1 to 1000.   
|-
|-
|offset
|offset
|0, 1, 2, ... 1000, ..., 10000, ..., n
|0, 1, 2, ... 1000, ..., 10000, ..., n
|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.  
|Controls the starting 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.  
|}
|}


Dstoner
1,554

edits

Retrieved from "http://www.idigbio.org/wiki/index.php/Special:MobileDiff/10135"