API Guide

Table 4. Examples of request headers
Request Header Description Example
x-auth-token Authentication token taken from the return
header of the SessionService/
Sessions POST operation to create a
session.
x-auth-token: d6399a19-38c8-467b-
a1ec-75ffa03efb7c
Accept-Language Choice of language that the client can
request—Optional.
Accept-Language: en
Response codes
For synchronous operations, the server returns HTTP response codes 200 or 204. For operations that take a long time, the server returns
a status code of 202 along with an HTTP response header (Location). This response corresponds to the URI of the temporary resource
that can be used to monitor the operation.
The following table lists some of the response codes:
Table 5. HTTP response codes
Request Response code
Success codes
GET
• 200 – OK with message body
• 204 – OK with no message body
• 206 – OK with partial message body
POST
• 201 – Resource created (operation complete)
• 202 – Resource accepted (operation pending)
PUT
• 202 – Accepted (operation pending)
• 204 – Success (operation complete)
DELETE
• 202 – Accepted (operation pending)
• 204 – Success (operation complete)
Failure codes
Invalid parameter 400 - Invalid parameter
Authorization 401 - Authorization failure
Permission denied 403 - Permission denied
Not found 404 - Resource not found
Invalid request method 405 - Invalid request method
Internal server error 500 - Internal server error
Service unavailable 503 - Service unavailable
For more information about response codes, see Status Code Definitions on the W3.org website.
Response headers
The following table lists a few examples of response headers:
Table 6. Examples of response headers
Response Header Description Example
Connection Control options for the current connection
and list of hop-by-hop request fields.
Connection: Keep-Alive
14 Key integration concepts