2.2.3.3.3 X-ResponseCode Header Field

The X-ResponseCode header contains a numerical value that represents the specific result that occurred on the server.

An X-ResponseCode of 0 (zero) means success from the perspective of the protocol transport, and the client SHOULD parse the response body based on the request that was issued. If the X-ResponseCode is not zero, the client parses the response body for diagnostic information.

The response codes that can be returned in the X-ResponseCode header are listed in the following table.

Code

Error

Description

0

Success

The request was properly formatted and accepted.

1

Unknown Failure

The request produced an unknown failure.

2

Invalid Verb

The request has an invalid verb.

3

Invalid Path

The request has an invalid path.

4

Invalid Header

The request has an invalid header.

5

Invalid Request Type

The request has an invalid X-RequestType header.

6

Invalid Context Cookie

The request has an invalid session context cookie.

7

Missing Header

The request has a missing required header.

8

Anonymous Not Allowed

The request is anonymous, but anonymous requests are not accepted.

9

Too Large

The request is too large.

10

Context Not Found

The Session Context is not found.

11

No Privilege

The client has no privileges to the Session Context.

12

Invalid Request Body

The request body is invalid.

13

Missing Cookie

The request is missing a required cookie.

14

Reserved

This value MUST be ignored by the client.

15

Invalid Sequence

The request has violated the sequencing requirement of one request at a time per Session Context.

16

Endpoint Disabled

The endpoint is disabled.

17

Invalid Response

The response is invalid.

18

Endpoint Shutting Down

The endpoint is shutting down.