RequestErrors Module

10.4 Client Error 4xx

The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition. These status codes are applicable to any request method. User agents SHOULD display any included entity to the user.

If the client is sending data, a server implementation using TCP SHOULD be careful to ensure that the client acknowledges receipt of the packet(s) containing the response, before the server closes the input connection. If the client continues sending data to the server after the close, the server's TCP stack will send a reset packet to the client, which may erase the client's unacknowledged input buffers before they can be read and interpreted by the HTTP application.

Functions and values

Function or value Description

BAD_REQUEST body

Full Usage: BAD_REQUEST body

Parameters:
    body : string

Returns: WebPart

400

The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

body : string
Returns: WebPart

CONFLICT body

Full Usage: CONFLICT body

Parameters:
    body : string

Returns: WebPart

409

The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request. The response body SHOULD include enough information for the user to recognize the source of the conflict. Ideally, the response entity would include enough information for the user or user agent to fix the problem; however, that might not be possible and is not required.

Conflicts are most likely to occur in response to a PUT request. For example, if versioning were being used and the entity being PUT included changes to a resource which conflict with those made by an earlier (third-party) request, the server might use the 409 response to indicate that it can't complete the request. In this case, the response entity would likely contain a list of the differences between the two versions in a format defined by the response Content-Type.

body : string
Returns: WebPart

FORBIDDEN body

Full Usage: FORBIDDEN body

Parameters:
    body : string

Returns: WebPart

403

The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead.

body : string
Returns: WebPart

GONE body

Full Usage: GONE body

Parameters:
    body : string

Returns: WebPart

410

The requested resource is no longer available at the server and no forwarding address is known. This condition is expected to be considered permanent. Clients with link editing capabilities SHOULD delete references to the Request-URI after user approval. If the server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 (Not Found) SHOULD be used instead. This response is cacheable unless indicated otherwise.

The 410 response is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable and that the server owners desire that remote links to that resource be removed. Such an event is common for limited-time, promotional services and for resources belonging to individuals no longer working at the server's site. It is not necessary to mark all permanently unavailable resources as "gone" or to keep the mark for any length of time -- that is left to the discretion of the server owner.

body : string
Returns: WebPart

METHOD_NOT_ALLOWED body

Full Usage: METHOD_NOT_ALLOWED body

Parameters:
    body : string

Returns: WebPart

405

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.

body : string
Returns: WebPart

NOT_ACCEPTABLE body

Full Usage: NOT_ACCEPTABLE body

Parameters:
    body : string

Returns: WebPart

406

The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

Unless it was a HEAD request, the response SHOULD include an entity containing a list of available entity characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection.

Note: HTTP/1.1 servers are allowed to return responses which are not acceptable according to the accept headers sent in the request. In some cases, this may even be preferable to sending a 406 response. User agents are encouraged to inspect the headers of an incoming response to determine if it is acceptable.

If the response could be unacceptable, a user agent SHOULD temporarily stop receipt of more data and query the user for a decision on further actions.

body : string
Returns: WebPart

NOT_FOUND body

Full Usage: NOT_FOUND body

Parameters:
    body : string

Returns: WebPart

404

Write the 'message' string to the body as UTF-8 encoded text, while returning 404 Not Found to the response

The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. The 410 (Gone) status code SHOULD be used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

body : string
Returns: WebPart

PRECONDITION_REQUIRED body

Full Usage: PRECONDITION_REQUIRED body

Parameters:
    body : string

Returns: WebPart

428

The 428 status code indicates that the origin server requires the request to be conditional.

Its typical use is to avoid the "lost update" problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict. By requiring requests to be conditional, the server can assure that clients are working with the correct copies.

Responses using this status code SHOULD explain how to resubmit the request successfully. For example:

 HTTP/1.1 428 Precondition Required
 Content-Type: text/html

 <html>
    <head>
       <title>Precondition Required</title>
    </head>
    <body>
       <h1>Precondition Required</h1>
       <p>This request is required to be conditional;
       try using "If-Match".</p>
    </body>
 </html>
val using: resource: 'T -> action: ('T -> 'U) -> 'U (requires 'T :> System.IDisposable)

Responses with the 428 status code MUST NOT be stored by a cache.

https://tools.ietf.org/html/rfc6585

body : string
Returns: WebPart

TOO_MANY_REQUESTS body

Full Usage: TOO_MANY_REQUESTS body

Parameters:
    body : string

Returns: WebPart

429

The user has sent too many requests in a given amount of time. Intended for use with rate limiting schemes.[18]

https://tools.ietf.org/html/rfc6585

body : string
Returns: WebPart

UNAUTHORIZED body

Full Usage: UNAUTHORIZED body

Parameters:
    body : string

Returns: WebPart

401

The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field (section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. If the 401 response contains the same challenge as the prior response, and the user agent has already attempted authentication at least once, then the user SHOULD be presented the entity that was given in the response, since that entity might include relevant diagnostic information. HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication" [43].

body : string
Returns: WebPart

UNPROCESSABLE_ENTITY body

Full Usage: UNPROCESSABLE_ENTITY body

Parameters:
    body : string

Returns: WebPart

422

The request was well-formed but was unable to be followed due to semantic errors.[4]

(WebDAV; RFC 4918)

body : string
Returns: WebPart

UNSUPPORTED_MEDIA_TYPE body

Full Usage: UNSUPPORTED_MEDIA_TYPE body

Parameters:
    body : string

Returns: WebPart

415

The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.

body : string
Returns: WebPart

bad_request bytes

Full Usage: bad_request bytes

Parameters:
    bytes : byte[]

Returns: WebPart

400

The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

bytes : byte[]
Returns: WebPart

challenge

Full Usage: challenge

Returns: WebPart

Composite:

HTTP/1.1 401 Unauthorized

WWW-Authenticate: Basic realm="protected"

A challenge response with a WWW-Authenticate header, and 401 Authorization Required response message.

Also see authenticate_basic and unauthorized

Returns: WebPart

conflict bytes

Full Usage: conflict bytes

Parameters:
    bytes : byte[]

Returns: WebPart

409

The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request. The response body SHOULD include enough information for the user to recognize the source of the conflict. Ideally, the response entity would include enough information for the user or user agent to fix the problem; however, that might not be possible and is not required.

Conflicts are most likely to occur in response to a PUT request. For example, if versioning were being used and the entity being PUT included changes to a resource which conflict with those made by an earlier (third-party) request, the server might use the 409 response to indicate that it can't complete the request. In this case, the response entity would likely contain a list of the differences between the two versions in a format defined by the response Content-Type.

bytes : byte[]
Returns: WebPart

forbidden bytes

Full Usage: forbidden bytes

Parameters:
    bytes : byte[]

Returns: WebPart

403

The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead.

bytes : byte[]
Returns: WebPart

gone bytes

Full Usage: gone bytes

Parameters:
    bytes : byte[]

Returns: WebPart

410

The requested resource is no longer available at the server and no forwarding address is known. This condition is expected to be considered permanent. Clients with link editing capabilities SHOULD delete references to the Request-URI after user approval. If the server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 (Not Found) SHOULD be used instead. This response is cacheable unless indicated otherwise.

The 410 response is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable and that the server owners desire that remote links to that resource be removed. Such an event is common for limited-time, promotional services and for resources belonging to individuals no longer working at the server's site. It is not necessary to mark all permanently unavailable resources as "gone" or to keep the mark for any length of time -- that is left to the discretion of the server owner.

bytes : byte[]
Returns: WebPart

method_not_allowed bytes

Full Usage: method_not_allowed bytes

Parameters:
    bytes : byte[]

Returns: WebPart

405

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.

bytes : byte[]
Returns: WebPart

not_acceptable bytes

Full Usage: not_acceptable bytes

Parameters:
    bytes : byte[]

Returns: WebPart

406

The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

Unless it was a HEAD request, the response SHOULD include an entity containing a list of available entity characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection.

Note: HTTP/1.1 servers are allowed to return responses which are not acceptable according to the accept headers sent in the request. In some cases, this may even be preferable to sending a 406 response. User agents are encouraged to inspect the headers of an incoming response to determine if it is acceptable.

If the response could be unacceptable, a user agent SHOULD temporarily stop receipt of more data and query the user for a decision on further actions.

bytes : byte[]
Returns: WebPart

not_found bytes

Full Usage: not_found bytes

Parameters:
    bytes : byte[]

Returns: WebPart

404

Send a 404 Not Found with a byte array body specified by the 's' parameter.

The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. The 410 (Gone) status code SHOULD be used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

bytes : byte[]
Returns: WebPart

precondition_required bytes

Full Usage: precondition_required bytes

Parameters:
    bytes : byte[]

Returns: WebPart

428

The 428 status code indicates that the origin server requires the request to be conditional.

Its typical use is to avoid the "lost update" problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict. By requiring requests to be conditional, the server can assure that clients are working with the correct copies.

Responses using this status code SHOULD explain how to resubmit the request successfully. For example:

 HTTP/1.1 428 Precondition Required
 Content-Type: text/html

 <html>
    <head>
       <title>Precondition Required</title>
    </head>
    <body>
       <h1>Precondition Required</h1>
       <p>This request is required to be conditional;
       try using "If-Match".</p>
    </body>
 </html>
val using: resource: 'T -> action: ('T -> 'U) -> 'U (requires 'T :> System.IDisposable)

Responses with the 428 status code MUST NOT be stored by a cache.

https://tools.ietf.org/html/rfc6585

bytes : byte[]
Returns: WebPart

request_timeout

Full Usage: request_timeout

Returns: WebPart

408

The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time.

Returns: WebPart

too_many_requests bytes

Full Usage: too_many_requests bytes

Parameters:
    bytes : byte[]

Returns: WebPart

429

The user has sent too many requests in a given amount of time. Intended for use with rate limiting schemes.[18]

https://tools.ietf.org/html/rfc6585

bytes : byte[]
Returns: WebPart

unauthorized bytes

Full Usage: unauthorized bytes

Parameters:
    bytes : byte[]

Returns: WebPart

401

The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field (section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. If the 401 response contains the same challenge as the prior response, and the user agent has already attempted authentication at least once, then the user SHOULD be presented the entity that was given in the response, since that entity might include relevant diagnostic information. HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication" [43].

bytes : byte[]
Returns: WebPart

unprocessable_entity bytes

Full Usage: unprocessable_entity bytes

Parameters:
    bytes : byte[]

Returns: WebPart

422

The request was well-formed but was unable to be followed due to semantic errors.[4]

(WebDAV; RFC 4918)

bytes : byte[]
Returns: WebPart

unsupported_media_type bytes

Full Usage: unsupported_media_type bytes

Parameters:
    bytes : byte[]

Returns: WebPart

415

The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.

bytes : byte[]
Returns: WebPart