Response Format
The response returned includes the following parts:
-
HTTP Response Code — The REST API uses standard 3–digit HTTP response status codes. See Errors.
-
HTTP Response headers — All headers have the meanings defined by the HTTP specification. The REST API returns a JSON-encoded response and response headers always include
Content-Type: application/json
. -
HTTP Response Body — The REST API returns the response as a JSON-encoded object. The JSON-encoded may include the properties listed in the following table.
Property |
Description |
---|---|
|
A string containing a brief message about the status of your request — for example |
|
An array containing the actual response elements. See Returned Data. |
|
An object containing response metadata. The
|
|
An object returned if the request fails with a HTTP status code |
|
An array contains expanded objects referenced by internal ID in the |