HTTP Status Codes

Common Successful Responses

Status Code

Message

Description

200

Ok

The requested information was successfully retrieved and can be found in the response body. Also used when a GET is issued for a collection and no matching items are returned in the response array.

201

Created

Used for synchronous resource creation. The URI of the new resource must be returned in the Location header.

202

Accepted

Used for asynchronous resource creation. The request was successfully received and validated by the server, but the requested resource hasn’t yet been created.

203

(Incomplete)

The information that was retrieved is incomplete. This is a rare occurrence.

204

No Content

The request was successful; the response doesn’t contain a body. You will see this when the request kicks off an asynchronous process and the response cannot be sent back immediately.

304

Not Modified

This is used if the If-Modified-Since header was included in the request. The 304 code means that the requested resource hasn’t been modified since the date given in the header, and so it isn’t returned in the body.

 

Unsuccessful Client Responses

Status Code

Message

Description

400

Bad Request

The request was unacceptable. The request cannot be fulfilled due to bad syntax or an invalid parameter.

401

Unauthorized

The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden

The server understood the request, but is refusing to fulfil it. It is a valid request, but it has been rejected by the server.

404

Not Found

The server has not found anything matching the request URI.

405

Method Not Supported

The server is unable to support the method.

406

Not Acceptable

The server is unable to return a response in the format that was requested by the client.

408

Request Timeout

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

409

Conflict

Request could not be processed because of a conflict in the current state of the resource, such as an edit conflict between multiple simultaneous updates.​

412

Precondition Failed

The server does not meet one of the preconditions that the requester put on the request header fields.

415

Unsupported Media Type

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.

429

Too Many Requests

The API management/proxy layer issues this response when the requesting client has exceeded specified rate limits.

 

Unsuccessful Server Responses

Status Code

Message

Description

500

Too Many Requests

Internal server error occurred.

502

Internal Server Error

The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfil the request.

503

Bad Gateway

Service temporarily unavailable.

504

Gateway Timeout

The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI.

505

HTTP Version Not Supported

The server does not support, or refuses to support, the HTTP protocol version that was used in the request message.

 

403 (Forbidden) Example

Insufficient permissions for the current user to access a given resource or due to suspended access.

{
    "description": "Not entitled for this request, please contact customer support."
    "code": 403,
    "message": "The resource is no longer available",
    "help": "See http://[elavon/US bank URL]",
    "details": attributeName is something or other + code
}