HTTP Response Codes

Refer to the API Open API/Swagger documentation for guidance.

EDR Response code and name Code Meaning/Possible reasons Impact and suggested actions
200 (OK)

Description:

The request is successful.

Expected behaviour, you can access the data.
302 (Found)

Description:

Redirect status response code indicating that the resource requested has been temporarily moved to the URL given by the Location header.

Expected behaviour for retrieving location ID (locId) payloads. Follow this redirect to access your payload.

400 (Bad Request)

Description:

The server cannot or will not process the request due to an apparent client error. For example, a query parameter had an incorrect value

Possible Reasons:

You may have included an invalid value for the parameter query string parameter, or datetime query string parameter with an invalid date time or range outside the available forecasts.

a) Check the error message returned in the API response, and

b) Adjust the parameter reported within the error message as being problematic. e.g. collection ID, location ID (locId), datetime (timestep), etc. 

The API Open API/Swagger documentation should also be consulted if necessary for implementation guidance.

401 (Unauthorized Request)

Description:

The request requires user authentication. The response includes a WWW-Authenticate header field containing a challenge applicable to the requested resource.

Possible Reasons

You may not have included your credentials in the request header or there could be a problem with the user credentials supplied.

You cannot access the data due to invalid authorisation. Please check that your authorisation token is valid and has not expired, and try again.

Please ensure you followed the setup instructions communicated to you by the QVA Manager.

403 (Forbidden)

Description:

The server understood the request, but is refusing to fulfil it. While status code 401 indicates missing or bad authentication, status code 403 indicates that authentication is not the issue, but the client is not authorized to perform the requested operation on the resource.

Possible Reasons:

Your request has been rejected as you do not have the rights to access or view the content.

This error can be returned by an origin due to an application firewall or other reason at the custom origin. 

This error code could be returned if, for example, your token has expired, or if you exceeded the number of requests specified by our Throttling policy limits. Please note that OAuth2 tokens are only valid for one hour. Please refresh your token if it has expired.

Additionally, you may need to make a further request to the /collections/{collectionId}/locations/{locationId} endpoint to obtain another signed URL to access the payload.  

404 (Not Found)

Description:

The requested resource does not exist on the server. For example, a path parameter had an incorrect value.

Possible Reasons:

You have entered an invalid URL, invalid collection name or location ID.

You may be attempting to access a resource that has not yet been published.

You should first check that your request is valid, in case you may have specified an invalid URL.

Please note:

  • If there is no published {collectionId} dataset, the collections/{collectionId} endpoint returns an HTTP 404 response. Call the /collections endpoint to check if there is currently a published dataset.

  • If there is no published {locationId} dataset for a given collection, the /collections/{collectionId}/locations/{locationId} endpoint returns an HTTP 404 response. Call the /collections/{collectionId}/locations endpoint to check if there is currently a published dataset.

500 (Internal Server Error)

Description:

An internal error occurred in the server.

Possible Reasons:

This could indicate that a Lambda function in our own systems returned an execution error.

You cannot access the data. Please try again.

If the error persists, please contact our Support teams.

502 (Bad Gateway)

Description:

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.

Possible Reasons:

It could indicate our server could not return the requested object because it couldn't connect to the origin server.

You cannot access the data. Please try again.

If the error persists, please contact our Support teams.

504 (Gateway Timeout)

Description:

While the request appears to be valid, the server failed to complete it in a timely manner.

You cannot access the data. Please try again. If the error persists, please contact our Support teams.