Response Format

All responses are JSON in the response body with an HTTP 200 response.

All responses include a stat field, for which the valid values are ok or error.

Success Response

The following is an example of a success response, including sample HTTP headers.


HTTP/1.1 200 OK
Cache-Control: no-store
Content-Type: application/json
{
  "result": {
    "id": "1",
    "firstName": "Robert"
  },
  "stat": "ok"
}
          

Error Response

Most error responses appear in the following form:


HTTP/1.1 200 OK
Cache-Control: no-store
Content-Type: application/json
{
  "code": 100,
  "error": "missing_argument",
  "argument_name": "uuid",
  "error_description": "missing required argument: uuid",
  "stat": "error"
}
          

OAuth Error Response

OAuth error responses appear in the following form:


HTTP/1.1 400 Bad Request
Cache-Control: no-store
Content-Type: application/json
{
  "code": 200,
  "error": "invalid_request",
  "sub_error": "invalid_argument",
  "argument_name": "grant_type",
  "error_description": "invalid grant_type: X",
  "stat": "error"
}