{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-portal/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Error Messages","description":"API documentation for SERV property and land registry services"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"error-messages","__idx":0},"children":["Error Messages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Suscription API uses standard HTTP response codes to indicate the success or failure of API requests."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"http-status-codes","__idx":1},"children":["HTTP Status Codes"]},{"$$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 Code"},"children":["Status Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["200"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success - The request was successful"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad Request - The request was malformed or invalid"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthorized - Authentication credentials are missing or invalid"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Forbidden - The authenticated user does not have access to this resource"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not Found - The requested address could not be found"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["429"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Too Many Requests - Rate limit exceeded"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["500"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal Server Error - An unexpected error occurred"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["503"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service Unavailable - The service is temporarily unavailable"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-response-format","__idx":2},"children":["Error Response Format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Error responses will include a JSON body with additional details:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-structure","__idx":3},"children":["Response Structure"]},{"$$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":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["errorType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Stable error code that can be used to decide how to handle an error"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["errorMessage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable description of the error"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-error-responses","__idx":4},"children":["Example Error Responses"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"invalid-input-400","__idx":5},"children":["Invalid Input (400)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"errorType\": \"INVALID_INPUT\",\n  \"errorMessage\": \"response - value is not a valid dict\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"unauthorized-401","__idx":6},"children":["Unauthorized (401)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"errorType\": \"UNAUTHORIZED\",\n  \"errorMessage\": \"Unauthorized\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"resource-not-found-404","__idx":7},"children":["Resource Not Found (404)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"errorType\": \"RECORD_NOT_FOUND\",\n  \"errorMessage\": \"Subscription record not found\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"internal-server-error-500","__idx":8},"children":["Internal Server Error (500)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"errorType\": \"INTERNAL_SERVER_ERROR\",\n  \"errorMessage\": \"The system has encountered an unexpected error, please try again later.\"\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Error Messages","id":"error-messages","depth":1},{"value":"HTTP Status Codes","id":"http-status-codes","depth":2},{"value":"Error Response Format","id":"error-response-format","depth":2},{"value":"Response Structure","id":"response-structure","depth":3},{"value":"Example Error Responses","id":"example-error-responses","depth":3},{"value":"Invalid Input (400)","id":"invalid-input-400","depth":4},{"value":"Unauthorized (401)","id":"unauthorized-401","depth":4},{"value":"Resource Not Found (404)","id":"resource-not-found-404","depth":4},{"value":"Internal Server Error (500)","id":"internal-server-error-500","depth":4}],"frontmatter":{"seo":{"title":"Error Messages"}},"lastModified":"2026-08-20T01:18:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/portal/rest/ddp-subscriptions-api/docs/error-messages","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}