IDigBio API v1 Specification: Difference between revisions

IDigBio API v1 Specification (view source)

100 bytes added , 28 May 2014

1,554

edits

@@ Line 36: / Line 36: @@
 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.
+For example, a Recordset record may include 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''
+If the number of related items for a particular type exceeds 20, the idigbio:links for that type of relation will be a single link to a List of items.  If the number of related items for a particular type is less than 20, the items will simply be included in the idigbio:links section.
 [[iDigBio API Examples]] includes examples that demonstrate this behavior.