The Queue-Fair Management REST API

To use the API and see full API documentation, see https://api.queue-fair.net. You can find more information about how Queue-Fair works in the Technical Guide, or the Queue-Fair Portal > Help section.

Error Model

The API will respond with a 200 OK if your request succeeds. If your request fails, it will respond with a 207 error code on most calls, however occasionally other error codes may be set for the HTTP response itself. The error message has its own "code" property, which is more useful than the "207" code returned by the HTTP response itself. The API can only be accessed over HTTPs, and SHOULD only respond with application/json but MAY occasionally respond with HTML if JSON cannot be produced.

Errors are usually due to poor formatting of input. The API is tolerant of whitespace in JSON but is case sensitive. All requests must be UTF-8 encoded, and text values should be appropriately JSON-escaped.

Error message codes

The list below shows the error codes that may be returned by our API code. The underlying framework may also return other codes under some circumstances.

Location	Code	Meaning
Response	200	Your request succeeded.
Response	207	Your request could not be processed successfully. Check the "code" of the error message for further details.
Response	404	The path of your request does not correspond to an API function.
Message	202	Your request was processed successfully but left the system unchanged. Make Live is not performed.
Message	400	Bad input data (value) that could not be processed.
Message	404	The requested object does not exist.
Message	405	The requested operation must be performed by Queue-Fair support.
Message	413	The file you tried to upload exceeded the 500k file size limit.
Message	500	Internal Server Error. See the error message for further details.

Exceptions and Errors

The list below shows the exceptions that may be returned by our API code. The underlying framework may also return other exceptions or errors under some circumstances.

Exception	Meaning
NoChangesException	Your request was processed successfully but left the system unchanged. Make Live is not performed.
InvalidArgumentException	Bad input data (value) that could not be processed.
UnexpectedValueException	Input data that should not be present, is too short or null, or collides with an existing value.
DatabaseException	Your changes could not be written to the database.
RuntimeException	Your changes were written to the database but could not be pushed to the live Queue Servers or Google Cloud. Try hitting Make Live in the Portal.
LengthException	The input data was too large.
BadMethodCallException	The operation must be performed by Queue-Fair support (only thrown if you try to change your account system name).