Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging.

If something unexplainable happened please don't hesitate to contact Punt Uit support.

Status codes

Here is a list of the different categories of status codes returned by the Punt Uit API. Use these to understand if a request was successful.

Name
2xx
Type
Description
A 2xx status code indicates a successful response.
Name
4xx
Type
Description
A 4xx status code indicates a client error — this means it's an error you can do something about.
Name
5xx
Type
Description
A 5xx status code indicates a server error.

Error types

Whenever a request is unsuccessful, the Punt Uit API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the two error types supported by the Punt Uit API — use these to understand what you have done wrong.

Name
message
Type
Description
The message describing the error, could be passed to the user if needed.
Name
error
Type
Description
The error details giving you hint on what went wrong

Error response

{
  "message": "Invalid format",
  "error": [
      {
          "instancePath": "",
          "schemaPath": "#/additionalProperties",
          "keyword": "additionalProperties",
          "params": {
              "additionalProperty": "foo"
          },
          "message": "must NOT have additional properties"
      }
  ]
}