Troubleshooting functionality errors
Error handling differs slightly between V1 and V2 endpoints and different areas of the documentation should be consulted for each.
V1 endpoint errors
Errors in V1 endpoints are indicated by a non '0' Result property and should be accompanied by an ExtendedResultCode
and ErrorDescription. The ErrorDescription will give a user-friendly description of the problem where appropriate. Information
on what the Result and ExtendedResultCode values mean is available on the following pages:
V2 endpoint errors
Errors in V2 endpoints are generally indicated by HTTP 400 and HTTP 404 responses. V2 endpoints will generally return
errors with an errorCode and a user-friendly description of the error.
{
"errorCode": "100",
"errors": [
{
"description": "Booking with id WH425CM at cinema 0000000001 is already cancelled or fully refunded"
}
]
}
The meaning of these error codes is documented in each individual endpoint in the V2 API Reference Section. Note that an error code can appear in multiple endpoints, but its meaning may differ depending on the endpoint being called. It's important to know the context an error code appears in to be able to diagnose the cause of the error correctly.
Unexpected errors
Unexpected errors indicate that Connect has encountered an error that it isn't able to handle, and are indicated by either a Result of '1' in the V1 endpoints, or an HTTP 500 response in the V2 endpoints. These errors can be caused by transitory faults such as timeouts with downstream systems or database servers, environment issues such as SSL security issues, bad data in the Connect database, or Connect bugs.
For unexpected errors, the best course of action is to consult the Connect logs and confirm whether an issue is caused by the environment setup or by Connect. A reproducible unexpected error is generally a bug in Connect and should be reported to Vista.