Internal API-Guide

Download As PDF

Response Codes

Success Message(s)

Code Text Description
200 OK The request was successful.
202 Accepted The request has been accepted, but not yet processed.
203 Non-Authoritative Information The request was successful, but the response data may be from a third party.

Redirection

Code Text Description
300 Multiple Choices The request has more than one representation options, for example, different file formats. Select a preferred representation and redirect your request to the representation location.
301 Moved Permanently The resource you requested has been permanently moved to a new location. Direct this and all future requests to the Uniform Resource Identifier (URI) specified in the Location response header.
302 Found The resource you requested has been temporarily moved to a new location. Direct this request to the temporary URI specified in the Location response header, but continue using the original URI for future requests.
303 See Other You can find the response to your request under another URI. Send a GET request to the URI specified in the Location response header.
304 Not Modified The resource has not been modified since last requested, so there is no new data to return.
305 Use Proxy Access the requested resource through the proxy provided in the Location response header.
307 Temporary Redirect The resource you requested has been temporarily moved to a new location. Direct this request to the temporary URI specified in the Location response header, but continue using the original URI for future requests. In contrast to code 302, you cannot change the request method when reissuing the original request.

Internal Error(s)

Code Text Description
400 Bad request The request was not accepted due to bad syntax, missing parameters, insufficient data, etc.
401 Unauthorized Missing or incorrect authentication credentials.
403 Forbidden You are not authorized to request this resource, or the resource is unavailable for some reason.
404 Not Found The request URI is incorrect, or the resource does not exist.
405 Method Not Allowed The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. The response must include an Allow header containing a list of valid methods for the requested resource.
406 Not Acceptable This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy. The proxy must return a Proxy-Authenticate header field containing a challenge applicable to the proxy for the requested resource. The Internal may repeat the request with a suitable Proxy-Authorization header field. HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication".
407 Proxy Authentication Required The format specified in the Accept header is not supported. Usually, the possible format is JSON. See Output Formats for details.
408 Request Timeout The server has timed out while waiting for the request. You can repeat the request without modifications at any later time.
409 Conflict The server was not able to process the request because of a conflict. Study the response body to recognize the source of the problem. Resolve the conflict and reissue the request.
410 Gone The resource you requested is no longer available. Do not request this resource again in the future.
411 Length Required You have not stated the length of the content, which is required by the server. Add a valid Content-Length header and repeat the request.
412 Precondition Failed The server could not meet one or more of the preconditions stated in the request headers.
413 Request Entity Too Large The request is larger than the server is willing or able to process.
414 Request-URI Too Long The URI provided is longer than the server is willing or able to interpret. You have probably used too many query-strings in a GET request. In this case, try to convert it into a POST request.
415 Unsupported Media Type The request contains a media type that the server or resource does not support.
416 Requested Range Not Satisfiable The server cannot provide the portion of the data that you specified in the Range request header. It is possible that the range is outside the size of the target data.
417 Expectation Failed The server could not meet the expectation stated in the Expect request header.
421 Misdirected Request The request was directed at a server that is not able to produce a response. This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI.
423 Locked The resource that is being accessed is locked.
424 Failed Dependency The request failed due to failure of a previous request.
425 Too Early Indicates that the server is unwilling to risk processing a request that might be replayed.
426 Upgrade Required The server refuses to perform the request using the current protocol but might be willing to do so after the Internal upgrades to a different protocol. The server sends an Upgrade header in a 426 response to indicate the required protocol(s).
428 Precondition Required Switch to a protocol stated in the Upgrade header and repeat the request.
429 Too Many Requests The user has sent too many requests in a given amount of time ("rate limiting").
431 Request Header Fields Too Large The server is unwilling to process the request because its header fields are too large. The request may be resubmitted after reducing the size of the request header fields.
451 Unavailable For Legal Reasons The user requests an illegal resource, such as a web page censored by a government.

Server Error(s)

Code Text Description
500 Internal Server Error Something went wrong, and the server was unable to complete your request. Should this problem persists.
503 Service Unavailable The server is currently unavailable, or you have reached the throttling limit. Throttling - To keeps our API healthy and protect it from overuse, we set limits on the number of calls you can make per time interval. When developing your app, make sure to respect the API call limits.
504 Gateway Timeout The server, while acting as a gateway or proxy, has waited too long for a response from the upstream server.
505 HTTP Version Not Supported The server does not support the HTTP version used in the request.
506 Variant Also Negotiates The server has an internal configuration error: transparent content negotiation for the request results in a circular reference.
507 Insufficient Storage The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.
508 Loop Detected The server detected an infinite loop while processing the request.
510 Not Extended Further extensions to the request are required for the server to fulfill it.
511 Network Authentication Required The 511 status code indicates that the Internal needs to authenticate to gain network access.