Overview
Supported HTTP methods
The eqwire API uses the following HTTP methods:
- POST
Creates a resource.
- GET
Reads a resource.
- PUT
Updates a resource. Instead of this method, you can use a similar method that uses the HTTP verb PATCH.
- PATCH
Updates a resource. Instead of this method, you can use a similar method that uses the HTTP verb PUT.
- DELETE
Removes a resource.
HTTP response codes
The eqwire API uses standard HTTP response codes to indicate the success or failure of a request:
Successful responses
- 200 OK
The request succeeded.
- 201 Created
The request succeeded, and a new resource was created as a result. This is typically the response sent after POST requests.
- 202 Accepted
The request was accepted for processing, but the processing will start later.
- 204 No Content
The request succeeded, but returned no response body.
Client error responses
- 400 Bad Request
The request was invalid (for example, malformed or syntactically incorrect). This code may indicate one of the following issues:
The API cannot convert the payload data to the underlying data type.
The data is not in the expected data format.
Required fields are not available.
A data validation error occurred.
- 401 Unauthorized
The request didn’t include an authentication token or the authentication token was expired.
- 403 Forbidden
The client didn’t have permissions to access the requested resource.
- 404 Not Found
The requested resource wasn’t found because the specified URI was invalid or the requested resource was unavailable (for example, a URI pointed to an empty database).
- 405 Method Not Allowed
The HTTP method in the request wasn’t supported by the resource.
- 406 Not Acceptable
The request wasn’t completed because the server doesn’t support the requested response format. For example, the request contained the
Accept: application/xmlheader, but the API can generate only theapplication/jsonresponse format.- 413 Payload Too Large
The request payload was larger than the server was able to process.
- 415 Unsupported Media Type
The request was rejected by the sever because it doesn’t support the requested data format. For example, the request contained the
Content-Type: application/xmlheader, but the API only accepts theapplication/jsonrequest format.- 429 Too Many Requests
The rate limit was reached. The rate limit set for the user, application or token exceeded a predefined value.
Server error responses
- 500 Internal Server Error
The request was not completed due to an internal error on the server side.
- 503 Service Unavailable
The server is down for maintenance.
For a full list of valid response codes, refer to the IANA HTTP Status Code Registry.
Date and time formats
The eqwire API supports the following formats for date and time representation:
JSON payloads — ISO 8601 date-time format. All date-time fields in responses must include the timezone.
Example:
2017-04-05T10:43:07+00:00HTTP headers — RFC 7231 full dates format.
Example:
Sun, 10 Sep 2017 19:43:31 UTC