To reduce the amount of redundant documentation and maintain a level of consistency throughout the web APIs, there are certain conventions that will be adhered to:
The following terms will be referenced throughout documentation:
Resource APIs in particular will make good use of HTTP verbs, or request methods. The standard
GET will be used for all non-destructive APIs that only return data, whereas any idempotent
operations will use
creation, replacement, modification and deletion of a resource.
POST requests will also be
used in non-resource-based APIs that perform actions.
Accept request header is not mandatory. Response type defaults to JSON for APIs that
support multiple formats.
We try to make sure that the HTTP status codes are self-describing and helpful. The following status codes will be produced by the web APIs under certain circumstances:
Certain error responses may return a body with more information about the error. This is usually a JSON
document with at least a