Response Format

All Catalyst API responses will be in the JSON format. The response is sent after a request is processed by the Catalyst server.

A typical response contains the status of the request processing, which can be success or failure, and a set of data based on the request made. For example, if the request was made to delete a record in a resource, the data will contain the details of the record that was deleted. The response details of each API are specified in its help page in detail.

If the request was not processed successfully, the response will contain an appropriate error code to specify the error that occurred. The next section contains the error codes recognized by Catalyst and their descriptions.

Sample API Response for the Request Made in the Previous Section


				{
    "status": "success",
    "data": {
        "cache_name": "City",
        "cache_value": "London",
        "project_details": {
            "id": 56000000087108,
            "project_name": "ShipmentTracking"
        },
        "segment_details": {
            "id": 56000000112489,
            "segment_name": "CustomerLocation"
        },
        "expires_in": "Mar 28, 2019 02:03 AM",
        "expiry_in_hours": 7
    }
}