Updated on 2024-12-30 GMT+08:00

Response

Status Code

After sending a request, you will receive a response that includes a 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 request.

For example, if status code 200 is returned for calling the API used to log in with a username and password, the request is successful.

(Optional) Response Header

Similar to a request, a response also has a header, for example, Content-type.

(Optional) Response Body

The body of a response is often returned in a structured format (for example, JSON or XML) to transfer content except the response header.

The following is part of the response body for the API used to log in with a username and password.

{
  "session_token" : "bts*********************************2VO",
  "expire" : 604800,
  "status" : "SUCCESS"
}

If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.

{
    "error_code": "LOGIN.0002",
    "error_msg": "Invalid account name or password. Remaining attempts: 8."
}

In the response body, error_code is an error code, and error_msg provides information about the error.