Response Codes💡
| Code | Reason | Description |
|---|---|---|
| 200 | OK | Everything worked as expected. |
| 201 | Created | The request has been fulfilled and resulted in a new resource being created. |
| 202 | Accepted | The request has been accepted for processing. See the extra information below for details. |
| 204 | No Content | Indicates that the request has succeeded, generally returned when a resource is successfully deleted. |
| 400 | Bad Request | The request was non accepted, often due to a required, missing parameter or resource, like a file that failed to upload or has been removed. |
| 401 | Unauthorized | No valid API key provided. Not allowed, Lizard has already started post-processing. |
| 402 | Request Failed | The parameters were valid but the request failed. |
| 403 | Forbidden | The API key doesn't have permissions to perform the request. |
| 404 | Not Found | The requested resource doesn't exist. |
| 409 | Conflict | The request conflicts with another request or an existing resource. See the extra information below for details. |
| 429 | Too Many Requests | Too many requests hit the API endpoint too quickly. See the extra information below for details. |
| 500, 502, 503, 504 | Server Errors | Something went wrong on 3Di's end. (These are rare.) |
Status code 202 extra information
Returned when a simulation has been added to the queue.
Status code 409 extra information
As mentioned above, the HTTP status code 409 is used to indicate a conflict. This includes a "Conflict with the
current simulation status" due to an attempted PATCH OR DELETE request for events during the simulation run time.
To be able to reproduce a simulation after it has finished, only the duration parameter might be patched once the simulation
has started. Once an event has been (partially) applied to a simulation, it cannot be deleted anymore for the same reason.
Status code 429 extra information
A response with this status code can be expected when the rate limit for your user account has been reached (also known as
throttling, see Throttling for details). The API also responds with this code if the session limit for your organisation
has been reached (the reason will be No available/free sessions).
Tip
If you build an application that potentially requests 3Di API resources at a high rate, we advise you to use an exponential backoff strategy.