ErrorResponse

2 minute read

Error response format.

Format

Error Classes

Each error class is accompanied by a specific HTTP status code. The table below shows the complete list of error classes along with the respective status codes. Example occurrences are given after the table.

Example Occurrences

AUTHENTICATION_FAILURE

• Missing access token, expired access token, etc.

ACCESS_DENIED

• The end-user is not is not entitled for the requested operation:
  • The support access code specified is not in the list of support access codes available for the authenticated user.
• The requested operation is prohibited by business logic:
  • The user tried to add a note to a case that has been closed for more than N days (example).

BAD_REQUEST

• Missing mandatory parameter, e.g. a support access code query parameter for Get-Products.
• JSON Schema validation failed.
• Date-time format is incorrect.

SERVICE_TEMPORARILY_UNAVAILABLE

• Connection failure to Axway Support Portal.

SERVER_ERROR

• A non-atomic method, such as Create Case or Add Note, completed only partially:
  • A case is successfully created but the subsequent call to retrieve all the case details fails. The error message will include a reference to (an identifier of) the case created in Support Portal.

Examples

{
    "code": "ACCESS_DENIED",
    "message": "The case has been closed for more than 45 days. Please contact Axway Global Support."
}

HTTP/1.1 403 Forbidden
Date: Wed, 10 Aug 2019 05:49:16 GMT
Connection: keep-alive
Strict-Transport-Security: max-age=15724800; includeSubDomains
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Troubleshooting-ID: dc8a785d4e41fe925fb204f9
Content-Type: application/json
Content-Length: 132

{
    "code": "ACCESS_DENIED",
    "message": "The case has been closed for more than 45 days. Please contact Axway Global Support."
}