IDigBio API v1 Specification: Difference between revisions

Jump to navigation Jump to search
(add note on curly braces →‎Endpoints)
Line 22: Line 22:
The curly braces <code> { </code> and <code> } </code> in this document are used as a placeholder to indicate that a real value needs to be substituted.  For example, <code> {api_version} </code> would be replaced with the actual representation of the API version such as "v1" (without the quotes).
The curly braces <code> { </code> and <code> } </code> in this document are used as a placeholder to indicate that a real value needs to be substituted.  For example, <code> {api_version} </code> would be replaced with the actual representation of the API version such as "v1" (without the quotes).


Most of the provided examples include a JSON formatter (such as json_pp) to make the output easier for humans to read. Additional usage examples as well as information on JSON formatting and the "curl" command, are available in [[iDigBio API Examples]].
Most of the provided usage examples include a JSON formatter (such as json_pp) to make the JSON document response easier for humans to read. Additional usage examples as well as information on JSON formatting and the "curl" command, are available in [[iDigBio API Examples]].


There are two major types of API enpoints:  
There are two major types of API enpoints: