Skip to main content

Response Object

Response format

FieldTypeDescription
codeintegerthe response state code
msgstringthe response message
dataobjectthe response data
errorstring or []stringthe error message or array of error messages
timestampintegerthe response timestamp
requestIdstringthe request ID
  • the code field 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 msg field is a string that provides a message about the response.
  • the data field is an object that contains the response data.
  • the error field is a string or an array of strings that provides error messages.
  • the timestamp field is an integer that provides the timestamp of the response.
  • the requestId field is a string that provides the request ID. if the request ID is not provided, it will be an uuid string.