Response Codes

Http Status Codes returned from the API

The following provides a list of the common response codes that may be returned from the Contract Eagle API with example scenarios.

Status Code

HTTP Methods

Scenario

200

OK

GET, PUT

This is the standard success code when retrieving data from the API or when data is successfully updated.

201

Created

POST

This is the standard success code when adding a new record

206

Partial

GET

This status code is used when retrieving document details and the size of the binary document data exceeds the maximum supported size for a single request.

Document meta-data is returned, but document binary data is excluded from the return value.

400

Bad Request

Any

Formatting errors in input data, validation errors or warnings were found whilst processing the data.

The details are returned in the JSON result.

Note: validation warnings are returned as errors when the fail on warnings flag is set in the request.

401

Unauthorized

Any

Missing or invalid authentication.

API is not enabled in the Contract Eagle UI.

403

Forbidden

Any

Either an attempted was made to access the API from an IP Address outside of the restricted range / within denied access range, or an attempt was made to retrieve or update data that the user context does not have permission to access.

404

Not found

GET

No value found matching the supplied filter.

Note: this status code will be returned if data does exist but the user does not have permission to access the requested data.


This value may also be returned when the API site is unavailable (eg: for maintenance). When this occurs, a standard HTML response will be returned, similar to the example below this table.

500

Internal Server Error

Any

An application error occurred - please contact Contract Eagle support to resolve.

404 - Site Down

When the API site is unexpectedly unavailable a standard HTML response similar to the following will be generated.

Please contact Contract Eagle support if this issue is not quickly resolved.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN""http://www.w3.org/TR/html4/strict.dtd">
<HTML><HEAD><TITLE>Not Found</TITLE>
<META HTTP-EQUIV="Content-Type" Content="text/html; charset=us-ascii"></HEAD>
<BODY><h2>Not Found</h2>
<hr><p>HTTP Error 404. The requested resource is not found.</p>
</BODY></HTML>