Returned Values

Status Code

After sending a request, you will receive a response, including the status code, response header, and response body.

A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see Status Codes.

If the API for obtaining the user token returns status code 201, the request is successful.

Response Header

A response header consists of an HTTP status code and additional response header fields.

  • HTTP status code: A status code consists of three digits (2xx to 5xx). 2xx indicates a success response. 4xx and 5xx indicate failure responses. Alternatively, a service-defined status code may be returned, as described in this document.
  • Optional header fields: For example, Content-type could be one of such fields. Common Response Parameters describes common response header fields.

Response Body

A response body conveys information other than the response header and is generally sent in a structured format (for example, JSON or XML) defined by the response header field Content-type.