{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Errors","siteUrl":"https://docs.api.dentally.com"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"errors","__idx":0},"children":["Errors"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Dentally NexGen API uses ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Problem Details for HTTP APIs"]}," ","(",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.rfc-editor.org/rfc/rfc7807"},"children":["RFC 7807"]},") for every error response."," ","This means error bodies are predictable: same shape, same fields, machine‑readable."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"envelope","__idx":1},"children":["Envelope"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"https://httpstatuses.io/400\",\n  \"title\": \"Bad Request\",\n  \"status\": 400,\n  \"detail\": \"Missing required field 'address'\",\n  \"instance\": \"/v2/sites\",\n  \"traceId\": \"00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URI"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifies the problem type. Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["about:blank"]}," if absent."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Short, human‑readable summary. Stable for a given problem type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP status code mirrored in the body."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human‑readable explanation specific to this occurrence."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URI"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reference to the specific occurrence (typically the request path)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["traceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Distributed trace identifier — quote this when contacting support."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The envelope is open to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["additional properties"]},": future problem types may"," ","add fields. Clients should ignore unknown properties."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"standard-responses","__idx":2},"children":["Standard responses"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When"},"children":["When"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Validation failed, malformed request, or unknown ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dentally-API-Version"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]}," describes the offending field or header."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing, invalid or expired bearer token."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/pages/authentication"},"children":["Authentication"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The resource does not exist or is not visible to the caller's practice scope."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["410 Gone"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The requested API version has been ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["sunset"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Link rel=\"sunset\""]}," to the changelog."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429 Too Many Requests"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A rate limit or spike arrest was exceeded."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RateLimit-*"]}," response headers. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/pages/rate-limiting"},"children":["Rate limiting"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["4XX"]}," other"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Other client errors (conflict, etc.)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Same Problem Details envelope."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5XX"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server error."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]}," is intentionally generic. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["traceId"]}," when reporting."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"handling-guidance","__idx":3},"children":["Handling guidance"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Branch on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},", not on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]}," strings — those may be"," ","refined or localised."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Log ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["traceId"]}]}," with your application logs so support can correlate"," ","failures end‑to‑end."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["4XX"]}," other and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5XX"]}]}," as the catch‑all for status codes not"," ","individually documented on an operation."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For per‑operation responses, see the API reference."]}]},"headings":[{"value":"Errors","id":"errors","depth":1},{"value":"Envelope","id":"envelope","depth":2},{"value":"Standard responses","id":"standard-responses","depth":2},{"value":"Handling guidance","id":"handling-guidance","depth":2}],"frontmatter":{"seo":{"title":"Errors"}},"lastModified":"2026-07-14T23:55:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/pages/errors","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}