Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. 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 with a status of 'error', you can use the acompanying message to figure out what has gone wrong and do some rudimentary debugging.

Status codes

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

Name
Description
A 2xx status code indicates a successful response.
Name
Description
A 4xx status code indicates a client error.
Name
Description
A 5xx status code indicates a server error.

Error types

Whenever a request has an error, the MPODx API will return a response with an status of 'error' and a message describing the error. 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. If you are unable to fix the error please reach out to MPODx support.

Error response

{
    "message": "Description of the error",
    "status": "error",
    "data": { //... data }
}