Response payload

API responses are wrapped in a standard payload that contains the results of the API request, as well as additional information and metadata.

Note: Currently all Alida APIs only support the JSON format. For more information, see JSON.

• Collection
  A collection is returned when a list is requested. The response payload for a collection is wrapped in extra metatags, whereas an instance only contains the entity information.
• Instance
  An instance is returned when a single entity is requested.
• Response Codes
  Response codes indicate if the request was successful or if an error occurred.

Parent topic: Using the API