Error handling

• Syntax errors
• Validation errors
• Service errors
• System errors

• message - An explanation of what went wrong
• path - The mutation or query containing the error
• code - A set value Tesouro uses to identify the error.
• advice - Information on how to fix and avoid the error if applicable

{
  "data": null,
  "errors": [
    {
      "message": "<a message describing the error>",
       "path": [
         "<name of mutation or query"
      ],
      "extensions": {
        "code": "<the error code>"
        ... // <optional additional fields>
      },
      ... // <optional additional fields>
    },
    ... // additional errors, if present
  ]
}

​

Tips

• If you use a table to lookup, it is important that you key off the “code” and not the “message”, as the code is a set value and should not change.
• In the case of multiple errors occurring within a single request, each error will be listed separately In the array.
• Errors returned by the Tesouro GraphQL API can be expected to be in compliance with the official GraphQL specification.