Rumo uses conventional HTTP status codes to indicate the success or failure of an API request. General codes:

  • 2xx for success;
  • 4xx for errors based on information provided in the request.
HTTP Code Type Description
200 Ok Standard response for successful HTTP requests. The actual response depends on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.
202 Accepted The request is successful and accepted for processing, but the processing didn’t complete. The request might or might not be acted upon and may not be allowed when the processing occurs.
403 Forbidden The request was valid, but the server is refusing action. You may not have the necessary permissions for a resource or may need an account. You must authenticate, naming the x-api-key key in the header of your requests after the API key we send you during your registration process.
413 Payload Too Large The request is larger than the server is willing or able to process. You may be uploading very large sources.You can split your JSON into several files. To ensure a consistent and reliable submission process, we recommend a maximum of 2000 entries for each JSON file.
415 Unsupported Media Type The request entity has a media type which the server or resource does not support. The JSON file you are trying to post may include formatting not supported by our API, which is unable to process it. Review and validate the JSON syntax before submitting your file. Code editors, such as Sublime Text or Visual Studio Code, include features (syntax highlighting and validation) to help you avoid formatting inconsistencies.