Troubleshooting

This guide is designed to help in understanding and resolving common errors that might be encountered while interacting with One Record API. By referencing the API specific error message format, issues can be quickly identified and troubleshooted.

Error Messages

When an error occurs, the API responds with a JSON object that provides details about the issue. Here is the structure of such error messages:

Generic Error

{
    "status": "<HTTP status code>",
    "timestamp": "<Time in ISO 8601 format>",
    "path": "<API endpoint path>",
    "messages": [
        "A human-readable message describing the error"   
    ]
}

Example Error

{
    "status": 429,
    "timestamp": "2024-03-18T13:20:47.355Z",
    "path": "/api/shipment",
    "message": [
        "Too Many Requests: Rate limit exceeded"
    ]
}

JSON Parsing Errors

When interfacing with One Record API, it's crucial to ensure that the JSON in request body is correctly formatted. A malformed JSON structure will lead to a 400 Bad Request error, specifically indicating "Problems parsing JSON".

This error is triggered when the API cannot interpret the request body as valid JSON. This might be due to syntax errors, incorrect data types, or improperly formatted structures, for example an array not closed properly ], an object missing its closing brace },…

Validation Failed

When interacting with the API, it's crucial to ensure that requests adhere to the expected parameters and data formats. An non-valid JSON will lead to a 422 Unprocessable Entity response with a "Validation Failed" message indicates that the request was well-formed but was not following the specified format.

This typically relates to issues with the provided data, such as missing mandatory fields, incorrect data formats, or other constraints that weren't met according to the API's specifications.