Axon.Response.Status

newtype Status

HTTP response status codes indicate whether a specific HTTP request has been successfully completed.

Responses are grouped in five classes:

1. Informational responses (100 – 199)
2. Successful responses (200 – 299)
3. Redirection messages (300 – 399)
4. Client error responses (400 – 499)
5. Server error responses (500 – 599)

Constructors

• Status Int

Instances

• Generic Status _
• Newtype Status _
• Show Status
• Eq Status
• Ord Status

continue :: Status

100 Continue This interim response indicates that the client should continue the request or ignore the response if the request is already finished.

switchingProtocols :: Status

101 Switching Protocols This code is sent in response to an "Upgrade" request header from the client and indicates the protocol the server is switching to.

processing :: Status

102 Processing

earlyHints :: Status

103 Early Hints This status code is primarily intended to be used with the "Link" header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources.

ok :: Status

200 OK The request succeeded. The result and meaning of "success" depends on the HTTP method:

• "GET": The resource has been fetched and transmitted in the message body.
• "HEAD": Representation headers are included in the response without any message body.
• "PUT" or "POST": The resource describing the result of the action is transmitted in the message body.
• "TRACE": The message body contains the request as received by the server.

created :: Status

201 Created The request succeeded, and a new resource was created as a result. This is typically the response sent after "POST" requests, or some "PUT" requests.

accepted :: Status

202 Accepted The request has been received but not yet acted upon.

It is noncommittal, since there is no way in HTTP to later send an asynchronous response indicating the outcome of the request.

It is intended for cases where another process or server handles the request, or for batch processing.

nonAuthoritativeInformation :: Status

203 Non-Authoritative Information This response code means the returned metadata is not exactly the same as is available from the origin server, but is collected from a local or a third-party copy.

This is mostly used for mirrors or backups of another resource.

Except for that specific case, the "200 OK" response is preferred to this status.

noContent :: Status

204 No Content There is no content to send for this request, but the headers are useful.

The user agent may update its cached headers for this resource with the new ones.

resetContent :: Status

205 Reset Content Tells the user agent to reset the document which sent this request.

partialContent :: Status

206 Partial Content This response code is used in response to a range request when the client has requested a part or parts of a resource.

multiStatus :: Status

207 Multi-Status Conveys information about multiple resources, for situations where multiple status codes might be appropriate.

alreadyReported :: Status

208 Already Reported Used inside a <dav:propstat> response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.

imUsed :: Status

226 IM Used The server has fulfilled a "GET" request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.

multipleChoices :: Status

300 Multiple Choices In agent-driven content negotiation, the request has more than one possible response and the user agent or user should choose one of them.

There is no standardized way for clients to automatically choose one of the responses, so this is rarely used.

movedPermanently :: Status

301 Moved Permanently The URL of the requested resource has been changed permanently. The new URL is given in the response.

found :: Status

302 Found This response code means that the URI of requested resource has been changed temporarily.

Further changes in the URI might be made in the future, so the same URI should be used by the client in future requests.

seeOther :: Status

303 See Other The server sent this response to direct the client to get the requested resource at another URI with a "GET" request.

notModified :: Status

304 Not Modified This is used for caching purposes.

It tells the client that the response has not been modified, so the client can continue to use the same cached version of the response.

temporaryRedirect :: Status

307 Temporary Redirect The server sends this response to direct the client to get the requested resource at another URI with the same method that was used in the prior request.

This has the same semantics as the 302 Found response code, with the exception that the user agent must not change the HTTP method used: if a "POST" was used in the first request, a POST must be used in the redirected request.

permanentRedirect :: Status

308 Permanent Redirect This means that the resource is now permanently located at another URI, specified by the "Location" response header.

This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a "POST" was used in the first request, a POST must be used in the second request.

badRequest :: Status

400 Bad Request The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

unauthorized :: Status

401 Unauthorized Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".

That is, the client must authenticate itself to get the requested response.

paymentRequired :: Status

402 Payment Required The initial purpose of this code was for digital payment systems, however this status code is rarely used and no standard convention exists.

forbidden :: Status

403 Forbidden The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource.

Unlike 401 Unauthorized, the client's identity is known to the server.

notFound :: Status

404 Not Found The server cannot find the requested resource.

In the browser, this means the URL is not recognized.

In an API, this can also mean that the endpoint is valid but the resource itself does not exist.

Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client.

This response code is probably the most well known due to its frequent occurrence on the web.

methodNotAllowed :: Status

405 Method Not Allowed The request method is known by the server but is not supported by the target resource.

For example, an API may not allow DELETE on a resource, or the TRACE method entirely.

notAcceptable :: Status

406 Not Acceptable This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent.

proxyAuthenticationRequired :: Status

407 Proxy Authentication Required This is similar to 401 Unauthorized but authentication is needed to be done by a proxy.

requestTimeout :: Status

408 Request Timeout This response is sent on an idle connection by some servers, even without any previous request by the client.

It means that the server would like to shut down this unused connection.

This response is used much more since some browsers use HTTP pre-connection mechanisms to speed up browsing.

Some servers may shut down a connection without sending this message.

conflict :: Status

409 Conflict This response is sent when a request conflicts with the current state of the server.

In WebDAV remote web authoring, 409 responses are errors sent to the client so that a user might be able to resolve a conflict and resubmit the request.

gone :: Status

410 Gone This response is sent when the requested content has been permanently deleted from server, with no forwarding address.

Clients are expected to remove their caches and links to the resource.

The HTTP specification intends this status code to be used for "limited-time, promotional services".

APIs should not feel compelled to indicate resources that have been deleted with this status code.

lengthRequired :: Status

411 Length Required Server rejected the request because the "Content-Length" header field is not defined and the server requires it.

preconditionFailed :: Status

412 Precondition Failed In conditional requests, the client has indicated preconditions in its headers which the server does not meet.

contentTooLarge :: Status

413 Content Too Large The request body is larger than limits defined by server.

The server might close the connection or return an "Retry-After" header field.

uriTooLong :: Status

414 URI Too Long The URI requested by the client is longer than the server is willing to interpret.

unsupportedMediaType :: Status

415 Unsupported Media Type The media format of the requested data is not supported by the server, so the server is rejecting the request.

rangeNotSatisfiable :: Status

416 Range Not Satisfiable The ranges specified by the Range header field in the request cannot be fulfilled.

It's possible that the range is outside the size of the target resource's data.

expectationFailed :: Status

417 Expectation Failed This response code means the expectation indicated by the "Expect" request header field cannot be met by the server.

imATeapot :: Status

418 I'm a teapot The server refuses the attempt to brew coffee with a teapot.

misdirectedRequest :: Status

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.

unprocessableContent :: Status

422 Unprocessable Content The request was well-formed but was unable to be followed due to semantic errors.

locked :: Status

423 Locked The resource that is being accessed is locked.

failedDependency :: Status

424 Failed Dependency The request failed due to failure of a previous request.

tooEarly :: Status

425 Too Early Indicates that the server is unwilling to risk processing a request that might be replayed.

upgradeRequired :: Status

426 Upgrade Required The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.

The server sends an "Upgrade" header in a 426 response to indicate the required protocol(s).

preconditionRequired :: Status

428 Precondition Required The origin server requires the request to be conditional.

This response is intended to prevent the 'lost update' problem, where a client "GET"s a resource's state, modifies it and "PUT"s it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict.

tooManyRequests :: Status

429 Too Many Requests The user has sent too many requests in a given amount of time.

requestHeaderFieldsTooLarge :: Status

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.

unavailableForLegalReasons :: Status

451 Unavailable For Legal Reasons The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.

internalServerError :: Status

500 Internal Server Error The server has encountered a situation it does not know how to handle.

This error is generic, indicating that the server cannot find a more appropriate 5XX status code to respond with.

notImplemented :: Status

501 Not Implemented The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are "GET" and "HEAD".

badGateway :: Status

502 Bad Gateway This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.

serviceUnavailable :: Status

503 Service Unavailable The server is not ready to handle the request.

Common causes are a server that is down for maintenance or that is overloaded.

Note that together with this response, a user-friendly page explaining the problem should be sent.

This response should be used for temporary conditions and the "Retry-After" HTTP header should, if possible, contain the estimated time before the recovery of the service.

The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.

gatewayTimeout :: Status

504 Gateway Timeout This error response is given when the server is acting as a gateway and cannot get a response in time.

hTTPVersionNotSupported :: Status

505 HTTP Version Not Supported The HTTP version used in the request is not supported by the server.

variantAlsoNegotiates :: Status

506 Variant Also Negotiates The server has an internal configuration error: during content negotiation, the chosen variant is configured to engage in content negotiation itself, which results in circular references when creating responses.

insufficientStorage :: Status

507 Insufficient Storage The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.

loopDetected :: Status

508 Loop Detected The server detected an infinite loop while processing the request.

notExtended :: Status

510 Not Extended The client request declares an HTTP Extension (RFC2774) that should be used to process the request, but the extension is not supported.

networkAuthenticationRequired :: Status

511 Network Authentication Required Indicates that the client needs to authenticate to gain network access.