Common error responses for the Reporting API
Unless otherwise noted, each of the following has an HTTPS status code of 200 OK, because the polling request itself was considered successful, even if it contains an error response from the system.
Invalid request parameters (INVALID_PARAMETER)
The system returns this response when a request is missing one of the parameters sendFromDate and sendToDate, or both are missing.
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Send From Date and Send To Date are required",
"errorDetails": []
}
The system returns this response when the sendFromDate is greater than the sendToDate.
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Send From Date can not be greater than Send To Date",
"errorDetails": []
}
The system returns this response when the filter date range is more than 30 days.
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Send From Date and Send To Date difference should not be more than 30",
"errorDetails": []
}
The system returns this response when the sendFromDate or sendToDate are not in the correct format YYYY-MM-DD.
{
"type": "",
"title": "Invalid date",
"errorCode": "INVALID_DATE",
"detail": "Date format should be yyyy-MM-dd",
"errorDetails": []
}