Skip to main content

Response structure

All GET and DELETE request parameters go as query parameters, and POST and PUT request parameters and responses are always JSON.

In the header, we have to pass two headers for all the API request

  1. Access-token: Access Token received from Login Flow

  2. Content-Type: application/json

Success response
HTTP/1.1 200 OK
Content-Type: application/json
{
                     
}

Failure response: 

HTTP/1.1 500 Server error
Content-Type: application/json
{
    "message": "Error message",  // error message is description passed in case of error
}

Data types​

Values in JSON responses are of types string, int, float, or bool.

Timestamp (datetime) strings in the responses are represented in the form yyyy-mm-dd hh:mm:ss, set under the Indian timezone (IST) ---UTC+5.5 hours.

A date string is represented in the form yyyy-mm-dd.