Authorization User Roles HTTP Methods Real-Time Data Streaming Status Codes Content Types Errors Pagination Rate Limiting Versioning
UNI-Cloud API 1.1
Overviewchevron_right
Endpointschevron_right
Please beware that the documentation is still in Alpha!
linkStatus Codes
marXact API uses conventional HTTP status 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 faile given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with marXact's servers (these are rare).
Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.
Example(s)
chevron_right200 -OK
The request was successful and the response body contains the requested data.
201 -Created
The request was successful and a new resource was created as a result. The response body may contain the new resource's data.
204 -No Content
The request was successful but there is no response body.
400 -Bad Request
The request was invalid or cannot be served. The response body may contain more information.
401 -Unauthorized
The request requires user authentication or the provided credentials are invalid.
403 -Forbidden
The request was valid, but the server is refusing to fulfill it.
404 -Not Found
The requested resource was not found.
405 -Method Not Allowed
The request method is not supported for the requested resource.
429 -Too Many Requests
Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500; 502; 503; 504 -Internal Server Error
An unexpected condition was encountered and no more specific message is suitable.