diff options
Diffstat (limited to 'core/api-common.rst')
| -rw-r--r-- | core/api-common.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/core/api-common.rst b/core/api-common.rst index 12f4a360..5171a2c6 100644 --- a/core/api-common.rst +++ b/core/api-common.rst @@ -43,27 +43,28 @@ handle the error as if an internal error (500) had been returned. **Response:** :resheader Content-Type: application/json - :status 200: + + :http:statuscode:`200 Ok`: The request was successful. - :status 301 Moved Permanently: + :http:statuscode:`301 Moved permanently`: The server responsible for the reserve changed, the client MUST follow the link to the new location. If possible, the client SHOULD remember the new URL for the reserve for future requests. Only applicable if the request method is GET. - :status 302 Found: + :http:statuscode:`302 Found`: The server responsible for the reserve changed, the client MUST follow the link to the new location, but MUST NOT retain the new URL for future requests. Only applicable if the request method is GET. - :status 307 Temporary Redirect: + :http:statuscode:`307 Temporary redirect`: The server responsible for the reserve changed, the client MUST follow the link to the new location, but MUST NOT retain the new URL for future requests. - :status 308 Permanent Redirect: + :http:statuscode:`308 Permanent redirect`: The server responsible for the reserve changed, the client MUST follow the link to the new location. If possible, the client SHOULD remember the new URL for the reserve for future requests. - :status 500 Internal server error: + :http:statuscode:`500 Internal server error`: This always indicates some serious internal operational error of the exchange, such as a program bug, database problems, etc., and must not be used for client-side problems. When facing an internal server error, clients should @@ -76,7 +77,7 @@ handle the error as if an internal error (500) had been returned. should naturally be able to address them in a timely fashion, especially within 24h. When generating an internal server error, the exchange responds with a JSON object containing the following fields: - :status 400 Bad Request: + :http:statuscode:`400 Bad request`: One of the arguments to the request is missing or malformed. Unless specified otherwise, all error status codes (4xx and 5xx) have a message |