1,554
edits
IDigBio API v1 Specification: Difference between revisions
Jump to navigation
Jump to search
→iDigBio Data and Schema
(add error code section) |
|||
| Line 15: | Line 15: | ||
Every record that is submitted to iDigBio receives a Globally Unique Identifier (GUID) of type UUID. The iDigBio UUID is represented by the "idigbio:uuid" data field. | Every record that is submitted to iDigBio receives a Globally Unique Identifier (GUID) of type UUID. The iDigBio UUID is represented by the "idigbio:uuid" data field. | ||
=== idigbio:links === | |||
The iDigBio API tries to follow the REST paradigm's HATEOAS (Hypermedia as the Engine of Application State) model, which basically means that within each API endpoint a list of relevant links to further API actions is included. The list of relevant links to further API actions is typically stored in "idigbio:links". | |||
For example, a Recordset record may have links to its publisher, the related records, and the related mediarecords. | |||
If the list of links is 20 or more, the link will instead go to another List rather than including the entire list in the body of the original List. ''This needs clarification. -dstoner'' | |||
== Endpoints == | == Endpoints == | ||