IDigBio API v1 Specification: Difference between revisions

Jump to navigation Jump to search
Line 32: Line 32:
*Media - A media endpoint returns one or more HTTP redirects to an actual media file (typically a JPEG image).
*Media - A media endpoint returns one or more HTTP redirects to an actual media file (typically a JPEG image).


=== 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''
[[iDigBio API Examples]] includes examples that demonstrate this behavior.


[[#toc|Back to contents]]
[[#toc|Back to contents]]
1,554

edits

Navigation menu