Summary of the codes provided in the response by the Inspire API endpoints
Each endpoint method in the Inspire API returns a response code. Inspire uses conventional HTTP response codes to indicate a successful or failed API call.
- Success is indicated by 2xx codes.
- Error is indicated by 4xx codes.
Success codes
Here is a summary of the codes indicating a successful request:
| Status code | Short Description | Explanation |
|---|---|---|
| 200 | Successful response | The API call was successful. Typically returned by GET methods. |
| 201 | Object created | Returned when an object was created as a result of the API call, usually by a POST method. |
| 202 | Object updated | Returned when an existing object was updated successfully. Typically returned by PUT and PATCH methods. |
| 204 | Object deleted | This code traditionally means the request was successfully processed, and there is no content to return. In the Inspire API, this code can be returned by PATCH and DELTE methods. |