Comment on page
Introduction
The default response format for the API:
{
"data":[],
"success":true,
"error":null,
"timestamp":1678875798,
"requestId": "abcd1234"
}
Name | Type | Description |
|---|---|---|
response | object | Contains the result of the API request if there is no error |
success | bool | Whether the request has been successful |
error | Error Object | contains error object, if any errors |
timestamp | long | response time in unix time milliseconds |
requestId | string | reference id related to the current request |
Data returned from a specific endpoint will be contained in the response object.
The error object will contain details of the error recorded with error id for the reference.
{
"isError":true,
"errorId":"3d9fc90d-30c2-4f63-bd40-c0a18c3ab4df",
"shortErrorMessage":"Error134",
"message":"Invalid Payload."
}
Name | Type | Description |
|---|---|---|
errorId | string | recorded error id for reference |
isError | bool | true, if reported error |
shortErrorMessage | string | Error code referencing the type of error |
message | string | detail description of the error reported |
Last modified 7mo ago