Skip to content

Response Structure

For all the API's, the response of any request comes in a standardised format. There are only 2 types of response which a user can expect

Successful Response

Sample Response
{
    "status": "success",
    "data": {}
}

Failed Response

Sample Response
{
    "status": "error",
    "message": "Error message",
    "errorCode": "GeneralException"
}

Note

The error code in the response is in a standard format, you can check the list of Error Codes over here

Data Types

The JSON Response has different data types as values. The following data types are possible -

  1. int (eg: 6, 1, 7, 4)
  2. float (eg: 1.729)
  3. bool (eg: true, false)
  4. Timestamp yyyy-mm-dd hh:mm:ss (eg: 2023-01-31 09:30:00)
  5. Datetime yyyy-mm-dd (eg: 2023-01-31)