Response Object
Response format
| Field | Type | Description |
|---|---|---|
code | integer | the response state code |
msg | string | the response message |
data | object | the response data |
error | string or []string | the error message or array of error messages |
timestamp | integer | the response timestamp |
requestId | string | the request ID |
- the
codefield is an integer that indicates the response state code. The code can be one of the following values:- 0: success
- 406: validation error or invalid request
- 500: internal server error
- 401: unauthorized
- 403: forbidden
- 404: not found
- 400: bad request
- the
msgfield is a string that provides a message about the response. - the
datafield is an object that contains the response data. - the
errorfield is a string or an array of strings that provides error messages. - the
timestampfield is an integer that provides the timestamp of the response. - the
requestIdfield is a string that provides the request ID. if the request ID is not provided, it will be an uuid string.