Response Format

All API responses are returned in a unified JSON format.

Success Response

When the request is processed successfully, the API returns code = 0. The response payload is contained in the data object, whose structure varies depending on the API.

{
    "code": 0,
    "data": {
        // the data associates with API
    }
}

Failure Response

When the request cannot be processed, the API returns code = -1 together with an application error code and a descriptive error message.

{
    "code": -1,
    "errCode": "001.001.001",
    "msg": "The requested resource could not be found"
}

Success Response#

Failure Response#

Success Response

Failure Response