Receiving Responses

Payload

All Server responses contain a root JSON object.

Each response will contain at least one of the following top-level members:

• data : the response’s “primary data”
• errors : an array of error objects

A response may contain any of these top-level members:

• links: a links object related to the primary data.
• included: an array of resource objects that are related to the primary data and/or each other (“included resources”).
• meta: not currently used.

If a document does not contain a top-level data key, the included member will not be present either.

{
  "data": {
    "type": "match",
    "id": "D005654E95174996B303A17B979DC016",
    "attributes": {
      // ... this match's attributes
    },
    "relationships": {
      // ... this matches relationships
    }
    "links": {}
  },
  "included": [
    {...},
    ...
  ],
  "links": {}
  "meta": {}
}