Xola

Responses

Xola uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a conflict occurred etc.), and codes in the 5xx range indicate an error with Xola's servers (these are rare).

Code
Meaning

200

Everything worked as expected.

201

New resource was created on Xola. Typically returned for a POST request.

202

Request has been accepted for processing. Typically returned for long running processes such as schedule changes and report generation.

205

Request was successfully processed but the server is not returning any content because multiple changes may have occurred. The client is expected to re-fetch the resource.

400

The request was unacceptable, often due to missing a required parameter.

401

No valid credentials provided.

402

The parameters were valid but the payment collection failed. Typically returned when charging a credit card fails.

403

You do not have the access to this resource

404

The requested resource doesn't exist.

409

The request could not be processed due to a resource mismatch. Typically returned when capacity or configuration has changed and the server can no longer honor the request.

5xx

Something went wrong on Xola's end. (These are rare.)