{"openapi":"3.0.3","info":{"title":"NHS Notify Supplier API","description":"## Overview\n\nUse this API to retrieve letters to be printed.\n\nThis API lets you:\n\n* get lists of letters allocated to you\n* download letter PDFs and metadata\n* update and manage letter statuses\n* submit and retrieve management information (MI)\n\nThis specification represents the in-development 'next' version of the API schema\nand should be treated as unstable.\n\n## Who can use this API\n\nThe NHS Notify Supplier API is designed for approved print service suppliers who support the delivery of physical letters through the [NHS Notify](https://digital.nhs.uk/services/nhs-notify) platform.\n\n## Access Modes\n\nThis API has one access mode. It is:\n\n* restricted access\n\n### Restricted access\n\nThis access mode is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate and authorise the calling application but not the end user.\n\nAuthentication and authorisation of end users is the responsibility of your application.\n\nTo use this access mode, use this security pattern:\n\n* [Application-restricted RESTful API - signed JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)\n\n## API status and roadmap\n\nThis API is [in production, beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses). We are onboarding partners to use it.\n\nWe may make additive non-breaking changes to the API without notice, for example the addition of fields to a response or callback, or new optional fields to a request.\n\n## Service level\n\nThis service is a [silver](https://digital.nhs.uk/services/reference-guide#service-levels) service, meaning it is available 24 hours a day, 365 days a year and supported from 8am to 6pm, Monday to Friday excluding bank holidays.\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Rate limits\n\nThe default rate limit is 300TPS (Transactions Per Second), per app. If you require a higher rate limit please [contact us](https://digital.nhs.uk/developer/help-and-support). or raise this during the onboarding process.\n\n## Technology\n\nThis API is a [REST-based](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest) API.\n\nWe follow the [JSON:API](https://jsonapi.org/) standard for our request and response schemas.\n\n### Response content types\n\nThis API can generate responses in the following format:\n\n* `application/vnd.api+json` - see [JSON:API specification](https://jsonapi.org/format/#introduction)\n\n### Request content types\n\nThis API will accept request payloads of the following types:\n\n* `application/vnd.api+json` - see [JSON:API specification](https://jsonapi.org/format/#introduction)\n* `application/json`\n\nThe `Content-Type` header may optionally include a `charset` attribute. If included, it **must** be set to `charset=utf-8` Any other `charset` value will result in a `406` error response. If omitted then `utf-8` is assumed.\n\nIf you attempt to send a payload without the `Content-Type` header set to either of these values then the API will respond with a `415 Unsupported Media Type` response.\n\n## Network access\n\nThis API is available on the internet and, indirectly on the [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network).\n\nFor more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).\n\n## Errors\n\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\n\n* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action\n* 400 to 499 if it failed because of a client error by your application\n* 500 to 599 if it failed because of an error on our server\n\nErrors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.\n\nYour API-calling application should have a mechanism to automatically try again, for example by giving status information to your end user, before giving up. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#error-handling) for more information about error handling.\n\n## Open source\n\nYou might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:\n\n| Resource                  | Description                                                          | Links                                                                          |\n|---------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| Notify Supplier API       | Source code for the API proxy, sandbox and specification.            | [GitHub repo](https://github.com/NHSDigital/notify-supplier-api) |\n\n## Environments and testing\n\n| Environment | Base URL |\n|------------ | -------- |\n| Sandbox     | `https://sandbox.api.service.nhs.uk/nhs-notify-supplier` |\n| Integration test | `https://int.api.service.nhs.uk/nhs-notify-supplier` |\n| Production | `https://api.service.nhs.uk/nhs-notify-supplier` |\n\n### Sandbox testing\n\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing):\n\n* is for early developer testing\n* only covers a limited set of scenarios\n* is stateless, so does not actually persist any updates\n* is open access, so does not allow you to test authorisation\n\nFor details of sandbox test scenarios, or to try out sandbox using our 'Try this API' feature, see the documentation for each endpoint.\n\nAlternatively, you can try out the sandbox using our Postman collection.\n\nYou can find our postman collection source in our [public repository on github](https://github.com/NHSDigital/nhs-notify-supplier-api/tree/main/postman).\n\n### Integration testing\n\nOur integration test environment:\n\n* is for formal integration sandbox-testing\n* is stateful, so persists updates\n* includes authorisation via [signed JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)\n\nYou need to get your software approved by us before it can go live with this API.\n\n### Production smoke testing\n\nBefore go-live, you must complete a smoke test in the NHS Notify production environment.\nThe smoke test confirms that your live credentials, connectivity, and print workflow operate correctly end-to-end. It will be carried out in coordination with the NHS Notify Supplier API team.\n\nThe process is as follows:\n\n* retrieve and print one or more live test letters through the production API.\n* send the printed output to the address provided.\n* submit a Management Information (MI) update for verification.\n\nThe NHS Notify team will configure your production access, review your results, and confirm that your output meets NHS Notify print specifications.\n\n## Onboarding\n\nYou need to get your software approved by us before it can go live with this API.\nYou will also need to be an approved NHS letter supplier under the framework agreement and nominate your technical and operational contacts.\n\n## Related APIs\n\nThe [NHS Notify API](https://digital.nhs.uk/developer/api-catalogue/nhs-notify) is used to send messages to citizens via NHS App, email, text message or letter.\n\n## Contact us\n\nFor help and support connecting to our APIs and to join our developer community, see [Help and support building healthcare software](https://digital.nhs.uk/developer/help-and-support).\n","termsOfService":null,"contact":null,"license":null,"version":"next"},"servers":[{"url":"https://internal-dev-sandbox.api.service.nhs.uk/nhs-notify-supplier","description":"Public sandbox","variables":null},{"url":"http://127.0.0.1:9000","description":"Local development server","variables":null}],"paths":{"/letters":{"$ref":null,"summary":null,"description":null,"get":{"tags":["letter"],"summary":"Get a list of PENDING letters","description":"## Overview\n\nUse this endpoint to poll letters which are ready to be printed.\n\nReturns letters whose `status` is **PENDING**.\nUse `limit` to control list size (max 2500).\n\nRate limiting applies. On excess requests, you may receive **429 Too Many Requests** (example error code(s): `NOTIFY_QUOTA`). Back off and retry later.\n","externalDocs":null,"operationId":"listLetters","parameters":[{"description":"The maximum number of items to return in a single request, max 2500","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"number","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":2500,"deprecated":null},"example":null,"examples":null,"content":null,"name":"limit","in":"query","allowEmptyValue":false,"allowReserved":false}],"requestBody":null,"responses":{"200":{"description":"List of letters to process","headers":{"X-Request-ID":{"description":"Unique request identifier, in the format of a GUID\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null},"X-Correlation-ID":{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding . characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header.\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null}},"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"data":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Letter"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"attributes":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["specificationId","status"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"specificationId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"groupId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"abc123","deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["PENDING","ACCEPTED","REJECTED","PRINTED","ENCLOSED","CANCELLED","DISPATCHED","DELIVERED","FAILED","RETURNED","FORWARDED"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The supplier status of an individual letter","format":null,"default":"PENDING","nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"PENDING","deprecated":null},"reasonCode":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Reason code for the given status","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"R01","deprecated":null},"reasonText":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Reason text for the given status","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"failed validation","deprecated":null},"sha256Hash":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Sha 256 hash of the letter content","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"get-letters":{"summary":null,"description":null,"value":{"data":[{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","status":"PENDING"},"id":"fcfd849ceec940e8832b41f4fc161e09","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","status":"PENDING"},"id":"7d64bd6a49e14213b47abbf6357eba0c","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","status":"PENDING"},"id":"2c06e7e32db4445fbbf56e7af223e0a2","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","status":"PENDING"},"id":"3b302a6122854695b5c514a4d28d18d5","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","status":"PENDING"},"id":"fbe3a53aac764a17a834699b8779958c","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","status":"PENDING"},"id":"393056c7cdc649deb29ee8d2651f29dd","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","status":"PENDING"},"id":"c6d0d4243f004b4e844003fbf80a9105","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"853817f0-d797-4eb2-bf40-2879a9b58117","status":"PENDING"},"id":"03aa3fb76d544ad483984bdd7fcd900b","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"9e5d5da7-5991-4ac9-9cee-559769912ca5","status":"PENDING"},"id":"7c9b698bf434479cabd0af946cc93f95","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"987276fd0dc94ddbab607d4a24693db2","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKk67isO29atr37M40VV8h4t","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKiDtfmA1SCybeljxWaXsTO4","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKeUmf6fBK2aCc5tK2AV8NLo","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKg0opQaKuPrBaA11MGPTX1p","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKjTJgMPTE4HdpgTvJcUmmW7","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKfx3DNyUmzXMZ4zby3vh5gi","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKlVCTgh4h1sTw6aiVcFdIwv","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKirJUuWKB3aoGr6KkFObelC","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKiUtgkjc3rS0xIYsqDOYYT4","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAKiQJZr3k2TBYboLgUWlR5NO","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAfv3V8RlfqSXOOtIZzNdjBFK","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAft7hTg2lKQhXhAxbPQTBudU","type":"Letter"},{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"634bcc87-fcc3-41fe-b6f9-c6a2125758e6","status":"PENDING"},"id":"32mAfv2nn1a9Kbfh4z19OyZw8Fo","type":"Letter"}]},"externalValue":null}},"encoding":null}},"links":null},"400":{"description":"Bad request, invalid input data","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-bad-request-unknown-parameter":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INVALID_REQUEST","detail":"Only 'limit' query parameter is supported","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"400","title":"Invalid request"}]},"externalValue":null},"error-bad-request-invalid-limit":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INVALID_REQUEST","detail":"The limit parameter must be a positive number not greater than 2500","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"400","title":"Invalid request"}]},"externalValue":null}},"encoding":null}},"links":null},"429":{"description":"Too many requests","headers":null,"content":{"application/json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Your application has exceeded its quota","deprecated":null},"scope":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"application","deprecated":null},"policy":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"quota","deprecated":null},"limit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":300,"deprecated":null},"interval":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1,"deprecated":null},"timeunit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"minute","deprecated":null},"ratelimiting_expiry_time_ms":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1625498765123,"deprecated":null},"message_id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"rrt-4773181658036170775-c-geu2-321623-73628915-2","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-too-many-requests":{"summary":null,"description":null,"value":{"interval":1,"limit":1,"message":"Your application, Notify-Supplier-App-Restricted - Internal Dev 2, has exceeded its quota of 1 requests every 1 minute(s) and is being rate limited.","message_id":"rrt-4773181658036170775-c-geu2-321623-73628915-2","policy":"quota","ratelimiting_expiry_time_ms":1765372560000,"scope":"application","timeunit":"minute"},"externalValue":null}},"encoding":null}},"links":null},"500":{"description":"Server error","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-server-error":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INTERNAL_SERVER_ERROR","detail":"An unexpected error occurred, please contact support","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"500","title":"Internal Server Error"}]},"externalValue":null}},"encoding":null}},"links":null},"502":{"description":"Bad gateway","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"API gateway error response","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad Gateway"}}}}}},"example":null,"examples":{"error-bad-request":{"summary":null,"description":null,"value":{"message":"Bad Gateway"},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"put":null,"post":{"tags":["letter"],"summary":"Update the status of multiple letters","description":"## Overview\n\nUse this endpoint to update the status for (example, PRINTED, DISPATCHED, DELIVERED) of multiple letters by providing the new statuses in the request body, optionally including reason codes and text.\n\nUse this endpoint when you need to report status changes for several letters at once.\n\nWhen you make a POST update request with the endpoint, it will respond with a successful (202) response code or an unsuccessful (4xx/5xx) response.\n\nRate limiting applies. On excess requests, you may receive **429 Too Many Requests** (example error code(s): `NOTIFY_QUOTA`). Back off and retry later.\n\n### Statuses\n\nAllowed `status` values that can be used to are:\n\n- `ACCEPTED`\n- `CANCELLED`\n- `DELIVERED`\n- `DISPATCHED`\n- `ENCLOSED`\n- `FAILED`\n- `FORWARDED`\n- `PRINTED`\n- `REJECTED`\n- `RETURNED`\n\nIt is not possible to update a letter to status of `PENDING`.\n\nThe request should not contain multiple letter objects with the same ID.\n\nOptionally a `reasonCode` and `reasonText` explaining the status (for example, validation failures) can be included in the request body for each update.\n\nWith the exception of the `RETURNED` status, `reasonCode` and `reasonText` can be agreed on an individual basis based on supplier workflows.\n\n#### RETURNED Updates\n\nNHS Notify uses a standardised set of reasons for the `RETURNED` status.\n\nBoth a `reasonCode` and `reasonText` <b>must</b> be provided for a `RETURNED` status update.\n\nThe reason codes and expected text for the `RETURNED` status are as follows:\n\n| Reason Code | Reason Text                |\n|-------------|----------------------------|\n|R01          |Addressee gone away         |\n|R02          |Address incomplete          |\n|R03          |Address inaccessible        |\n|R04          |Addressee unknown           |\n|R05          |Addressee gone away/Refused |\n|R06          |Not called for              |\n|R07          |No such address             |\n|R08          |No reason given             |\n|R09          |Deceased                    |\n|R10          |Miscellaneous               |\n","externalDocs":null,"operationId":"postLetters","parameters":null,"requestBody":{"description":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["data"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"data":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["type","id","attributes"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Letter"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"attributes":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["status"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["PENDING","ACCEPTED","REJECTED","PRINTED","ENCLOSED","CANCELLED","DISPATCHED","DELIVERED","FAILED","RETURNED","FORWARDED"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The supplier status of an individual letter","format":null,"default":"PENDING","nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"PENDING","deprecated":null},"reasonCode":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Reason code for the given status","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"R01","deprecated":null},"reasonText":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Reason text for the given status","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"failed validation","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"post-letter-request":{"summary":null,"description":null,"value":{"data":[{"attributes":{"status":"PENDING"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"},{"attributes":{"status":"ACCEPTED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"},{"attributes":{"status":"PRINTED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"},{"attributes":{"status":"ENCLOSED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"},{"attributes":{"status":"DISPATCHED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"},{"attributes":{"status":"DELIVERED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"},{"attributes":{"reasonCode":"R01","reasonText":"failed validation","status":"RETURNED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"},{"attributes":{"reasonCode":"R01","reasonText":"failed validation","status":"CANCELLED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"},{"attributes":{"reasonCode":"R01","reasonText":"failed validation","status":"FAILED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"},{"attributes":{"reasonCode":"R01","reasonText":"failed validation","status":"RETURNED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}]},"externalValue":null}},"encoding":null}},"required":false},"responses":{"202":{"description":"202 (Accepted) Acknowledges that status updates have been posted","headers":{"X-Request-ID":{"description":"Unique request identifier, in the format of a GUID\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null},"X-Correlation-ID":{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding . characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header.\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null}},"content":null,"links":null},"400":{"description":"Bad request, invalid input data","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-bad-request":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INVALID_REQUEST","detail":"Invalid request, please refer to the API specifications","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"400","title":"Invalid request"}]},"externalValue":null}},"encoding":null}},"links":null},"429":{"description":"Too many requests","headers":null,"content":{"application/json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Your application has exceeded its quota","deprecated":null},"scope":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"application","deprecated":null},"policy":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"quota","deprecated":null},"limit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":300,"deprecated":null},"interval":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1,"deprecated":null},"timeunit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"minute","deprecated":null},"ratelimiting_expiry_time_ms":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1625498765123,"deprecated":null},"message_id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"rrt-4773181658036170775-c-geu2-321623-73628915-2","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-too-many-requests":{"summary":null,"description":null,"value":{"interval":1,"limit":1,"message":"Your application, Notify-Supplier-App-Restricted - Internal Dev 2, has exceeded its quota of 1 requests every 1 minute(s) and is being rate limited.","message_id":"rrt-4773181658036170775-c-geu2-321623-73628915-2","policy":"quota","ratelimiting_expiry_time_ms":1765372560000,"scope":"application","timeunit":"minute"},"externalValue":null}},"encoding":null}},"links":null},"500":{"description":"Server error","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-server-error":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INTERNAL_SERVER_ERROR","detail":"An unexpected error occurred, please contact support","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"500","title":"Internal Server Error"}]},"externalValue":null}},"encoding":null}},"links":null},"502":{"description":"Bad gateway","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"API gateway error response","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad Gateway"}}}}}},"example":null,"examples":{"error-bad-request":{"summary":null,"description":null,"value":{"message":"Bad Gateway"},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":[{"description":"An OAuth 2.0 bearer token. Required in integration and production environments.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^Bearer [[:ascii:]]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","deprecated":null},"example":null,"examples":null,"content":null,"name":"Authorization","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Unique request identifier, in the format of a GUID","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place.\nThe ID will be returned in a response header.","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false}]},"/letters/{id}":{"$ref":null,"summary":null,"description":null,"get":{"tags":["letter"],"summary":"Retrieve the status of a letter","description":"## Overview\n\nUse this endpoint to get the current status of a single letter by its ID.\n\nRate limiting applies. On excess requests, you may receive **429 Too Many Requests** (example error code(s): `NOTIFY_QUOTA`). Back off and retry later.\n\n## Sandbox test scenarios\n\nYou can test the following scenarios in our sandbox environment\n\n| Scenario                                | Letter Id                    |\n| ----------------------------------------| ---------------------------- |\n| Retrieve a PENDING letter status        | `24L5eYSWGzCHlGmzNxuqVusPxDg`|\n| Retrieve a ACCEPTED letter status       | `2AL5eYSWGzCHlGmzNxuqVusPxDg`|\n| Retrieve a PRINTED letter status        | `2BL5eYSWGzCHlGmzNxuqVusPxDg`|\n| Retrieve a ENCLOSED letter status       | `2CL5eYSWGzCHlGmzNxuqVusPxDg`|\n| Retrieve a DISPATCHED letter status     | `2DL5eYSWGzCHlGmzNxuqVusPxDg`|\n| Retrieve a DELIVERED letter status      | `2EL5eYSWGzCHlGmzNxuqVusPxDg`|\n| Retrieve a REJECTED letter status       | `2WL5eYSWGzCHlGmzNxuqVusPxDg`|\n| Retrieve a CANCELLED letter status      | `2XL5eYSWGzCHlGmzNxuqVusPxDg`|\n| Retrieve a FAILED letter status         | `2YL5eYSWGzCHlGmzNxuqVusPxDg`|\n| Retrieve a RETURNED letter status       | `2ZL5eYSWGzCHlGmzNxuqVusPxDg`|\n\n### Example Error Codes\n\nExamples of reason codes and text that may be returned include (but are not limited to)\n\n| Reason Code | Reason Text                |\n|-------------|----------------------------|\n|R01          |Addressee gone away         |\n|R02          |Address incomplete          |\n|R03          |Address inaccessible        |\n|R04          |Addressee unknown           |\n|R05          |Addressee gone away/Refused |\n|R06          |Not called for              |\n|R07          |No such address             |\n|R08          |No reason given             |\n|R09          |Deceased                    |\n|R10          |Miscellaneous               |\n","externalDocs":null,"operationId":"getLetterStatus","parameters":null,"requestBody":null,"responses":{"200":{"description":"Letter status","headers":{"X-Request-ID":{"description":"Unique request identifier, in the format of a GUID\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null},"X-Correlation-ID":{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding . characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header.\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null}},"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["data"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"data":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Letter"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"attributes":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["specificationId","status"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"specificationId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"groupId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"abc123","deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["PENDING","ACCEPTED","REJECTED","PRINTED","ENCLOSED","CANCELLED","DISPATCHED","DELIVERED","FAILED","RETURNED","FORWARDED"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The supplier status of an individual letter","format":null,"default":"PENDING","nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"PENDING","deprecated":null},"reasonCode":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Reason code for the given status","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"R01","deprecated":null},"reasonText":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Reason text for the given status","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"failed validation","deprecated":null},"sha256Hash":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Sha 256 hash of the letter content","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"get-letters":{"summary":null,"description":null,"value":{"data":{"attributes":{"groupId":"c5d93f917f5546d08beccf770a915d96","sha256Hash":"3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6","specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","status":"PENDING"},"id":"24L5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null}},"encoding":null}},"links":null},"404":{"description":"Resource not found","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-not-found":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_RESOURCE_NOT_FOUND","detail":"No resource found with that ID","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"404","title":"Resource not found"}]},"externalValue":null}},"encoding":null}},"links":null},"429":{"description":"Too many requests","headers":null,"content":{"application/json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Your application has exceeded its quota","deprecated":null},"scope":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"application","deprecated":null},"policy":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"quota","deprecated":null},"limit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":300,"deprecated":null},"interval":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1,"deprecated":null},"timeunit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"minute","deprecated":null},"ratelimiting_expiry_time_ms":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1625498765123,"deprecated":null},"message_id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"rrt-4773181658036170775-c-geu2-321623-73628915-2","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-too-many-requests":{"summary":null,"description":null,"value":{"interval":1,"limit":1,"message":"Your application, Notify-Supplier-App-Restricted - Internal Dev 2, has exceeded its quota of 1 requests every 1 minute(s) and is being rate limited.","message_id":"rrt-4773181658036170775-c-geu2-321623-73628915-2","policy":"quota","ratelimiting_expiry_time_ms":1765372560000,"scope":"application","timeunit":"minute"},"externalValue":null}},"encoding":null}},"links":null},"500":{"description":"Server error","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-server-error":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INTERNAL_SERVER_ERROR","detail":"An unexpected error occurred, please contact support","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"500","title":"Internal Server Error"}]},"externalValue":null}},"encoding":null}},"links":null},"502":{"description":"Bad gateway","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"API gateway error response","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad Gateway"}}}}}},"example":null,"examples":{"error-bad-request":{"summary":null,"description":null,"value":{"message":"Bad Gateway"},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"put":null,"post":null,"delete":null,"options":null,"head":null,"patch":{"tags":["letter"],"summary":"Update the status of a letter","description":"## Overview\n\nUse this endpoint to update the status of a letter by submitting the new status in the request body, optionally providing a reason code and text.\n\nWhen you make a PATCH request with your application, the endpoint will respond with an accepted (202) response code or an unsuccessful (4xx/5xx) response.\n\nRate limiting applies. On excess requests, you may receive **429 Too Many Requests** (example error code(s): `NOTIFY_QUOTA`). Back off and retry later.\n\n### Statuses\n\nAllowed `status` values that can be used to are:\n\n- `ACCEPTED`\n- `CANCELLED`\n- `DELIVERED`\n- `DISPATCHED`\n- `ENCLOSED`\n- `FAILED`\n- `FORWARDED`\n- `PRINTED`\n- `REJECTED`\n- `RETURNED`\n\nIt is not possible to update a letter to status of `PENDING`.\n\n### Reason Codes\n\nOptionally a `reasonCode` and `reasonText` explaining the status (for example, validation failures) can be included in the request body.\n\nWith the exception of the `RETURNED` status, `reasonCode` and `reasonText` can be agreed on an individual basis\n\n#### RETURNED Updates\n\nNHS Notify uses a standardised set of reasons for the `RETURNED` status.\n\nBoth a `reasonCode` and `reasonText` <b>must</b> be provided for a `RETURNED` status update.\n\nThe reason codes and expected text for the `RETURNED` status are as follows:\n\n| Reason Code | Reason Text                |\n|-------------|----------------------------|\n|R01          |Addressee gone away         |\n|R02          |Address incomplete          |\n|R03          |Address inaccessible        |\n|R04          |Addressee unknown           |\n|R05          |Addressee gone away/Refused |\n|R06          |Not called for              |\n|R07          |No such address             |\n|R08          |No reason given             |\n|R09          |Deceased                    |\n|R10          |Miscellaneous               |\n","externalDocs":null,"operationId":"patchLetter","parameters":null,"requestBody":{"description":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["data"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"data":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["type","id","attributes"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Letter"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"attributes":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["status"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["PENDING","ACCEPTED","REJECTED","PRINTED","ENCLOSED","CANCELLED","DISPATCHED","DELIVERED","FAILED","RETURNED","FORWARDED"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The supplier status of an individual letter","format":null,"default":"PENDING","nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"PENDING","deprecated":null},"reasonCode":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Reason code for the given status","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"R01","deprecated":null},"reasonText":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Reason text for the given status","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"failed validation","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"patch-letter-request-default":{"summary":"Request for default (PENDING) update","description":null,"value":{"data":{"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-pending":{"summary":"Request for PENDING update","description":null,"value":{"data":{"attributes":{"status":"PENDING"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-accepted":{"summary":"Request for ACCEPTED update","description":null,"value":{"data":{"attributes":{"status":"ACCEPTED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-rejected":{"summary":"Request for REJECTED update","description":null,"value":{"data":{"attributes":{"reasonCode":"R07","reasonText":"No such address","status":"REJECTED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-printed":{"summary":"Request for PRINTED update","description":null,"value":{"data":{"attributes":{"status":"PRINTED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-enclosed":{"summary":"Request for ENCLOSED update","description":null,"value":{"data":{"attributes":{"status":"ENCLOSED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-cancelled":{"summary":"Request for CANCELLED update","description":null,"value":{"data":{"attributes":{"reasonCode":"R10","reasonText":"Miscellaneous","status":"CANCELLED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-dispatched":{"summary":"Request for DISPATCHED update","description":null,"value":{"data":{"attributes":{"status":"DISPATCHED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-delivered":{"summary":"Request for DELIVERED update","description":null,"value":{"data":{"attributes":{"status":"DELIVERED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-failed":{"summary":"Request for FAILED update","description":null,"value":{"data":{"attributes":{"reasonCode":"R10","reasonText":"Miscellaneous","status":"FAILED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-returned":{"summary":"Request for RETURNED update","description":null,"value":{"data":{"attributes":{"reasonCode":"R01","reasonText":"Addressee gone away","status":"REJECTED"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-invalid":{"summary":"Request for an invalid update","description":null,"value":{"data":{"attributes":{"status":"INVALID_STATUS"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"Letter"}},"externalValue":null},"patch-letter-request-not-found":{"summary":"Request for a non existant letter","description":null,"value":{"data":{"attributes":{"status":"ACCEPTED"},"id":"123654789","type":"Letter"}},"externalValue":null}},"encoding":null}},"required":false},"responses":{"202":{"description":"202 (Accepted) Acknowledges Letter resource update has been received","headers":{"X-Request-ID":{"description":"Unique request identifier, in the format of a GUID\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null},"X-Correlation-ID":{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding . characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header.\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null}},"content":null,"links":null},"400":{"description":"Bad request, invalid input data","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-bad-request-invalid-request-body":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INVALID_REQUEST","detail":"The request body is invalid","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"400","title":"Invalid request"}]},"externalValue":null}},"encoding":null}},"links":null},"404":{"description":"Resource not found","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-not-found":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_RESOURCE_NOT_FOUND","detail":"No resource found with that ID","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"404","title":"Resource not found"}]},"externalValue":null}},"encoding":null}},"links":null},"429":{"description":"Too many requests","headers":null,"content":{"application/json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Your application has exceeded its quota","deprecated":null},"scope":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"application","deprecated":null},"policy":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"quota","deprecated":null},"limit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":300,"deprecated":null},"interval":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1,"deprecated":null},"timeunit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"minute","deprecated":null},"ratelimiting_expiry_time_ms":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1625498765123,"deprecated":null},"message_id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"rrt-4773181658036170775-c-geu2-321623-73628915-2","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-too-many-requests":{"summary":null,"description":null,"value":{"interval":1,"limit":1,"message":"Your application, Notify-Supplier-App-Restricted - Internal Dev 2, has exceeded its quota of 1 requests every 1 minute(s) and is being rate limited.","message_id":"rrt-4773181658036170775-c-geu2-321623-73628915-2","policy":"quota","ratelimiting_expiry_time_ms":1765372560000,"scope":"application","timeunit":"minute"},"externalValue":null}},"encoding":null}},"links":null},"500":{"description":"Server error","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-server-error":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INTERNAL_SERVER_ERROR","detail":"An unexpected error occurred, please contact support","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"500","title":"Internal Server Error"}]},"externalValue":null}},"encoding":null}},"links":null},"502":{"description":"Bad gateway","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"API gateway error response","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad Gateway"}}}}}},"example":null,"examples":{"error-bad-request":{"summary":null,"description":null,"value":{"message":"Bad Gateway"},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"trace":null,"servers":null,"parameters":[{"description":"An OAuth 2.0 bearer token. Required in integration and production environments.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^Bearer [[:ascii:]]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","deprecated":null},"example":null,"examples":null,"content":null,"name":"Authorization","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Unique request identifier, in the format of a GUID","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place.\nThe ID will be returned in a response header.","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Unique identifier of this resource","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"24L5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"example":null,"examples":null,"content":null,"name":"id","in":"path","allowEmptyValue":false,"allowReserved":false}]},"/letters/{id}/data":{"$ref":null,"summary":null,"description":null,"get":{"tags":["data"],"summary":"Fetch a data file","description":"## Overview\n\nUse this endpoint to get letter data, including downloading the letter's print-ready PDF file.\n\nRate limiting applies. On excess requests, you may receive **429 Too Many Requests** (example error code(s): `NOTIFY_QUOTA`). Back off and retry later.\n\n## Sandbox test scenarios\n\nYou can test the following scenarios in our sandbox environment.\n\n|Scenario|Request ID|Response|\n|--------|-------|--------|\n|Success  | 2AL5eYSWGzCHlGmzNxuqVusPxDg | Returns 303 (See Other) and URL to an example PDF in the Location header |\n|Not found |2WL5eYSWGzCHlGmzNxuqVusPxDg | Returns 404 Not found and error details in the response |\n","externalDocs":null,"operationId":"getDataId","parameters":null,"requestBody":null,"responses":{"303":{"description":"See Other","headers":{"Location":{"description":"The signed S3 URL of the data file to download","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":"https://examples3bucket.com/filelocation","examples":null,"content":null},"X-Request-ID":{"description":"Unique request identifier, in the format of a GUID\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null},"X-Correlation-ID":{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding . characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header.\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null}},"content":null,"links":null},"404":{"description":"Resource not found","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-not-found":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_RESOURCE_NOT_FOUND","detail":"No resource found with that ID","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"404","title":"Resource not found"}]},"externalValue":null}},"encoding":null}},"links":null},"429":{"description":"Too many requests","headers":null,"content":{"application/json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Your application has exceeded its quota","deprecated":null},"scope":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"application","deprecated":null},"policy":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"quota","deprecated":null},"limit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":300,"deprecated":null},"interval":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1,"deprecated":null},"timeunit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"minute","deprecated":null},"ratelimiting_expiry_time_ms":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1625498765123,"deprecated":null},"message_id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"rrt-4773181658036170775-c-geu2-321623-73628915-2","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-too-many-requests":{"summary":null,"description":null,"value":{"interval":1,"limit":1,"message":"Your application, Notify-Supplier-App-Restricted - Internal Dev 2, has exceeded its quota of 1 requests every 1 minute(s) and is being rate limited.","message_id":"rrt-4773181658036170775-c-geu2-321623-73628915-2","policy":"quota","ratelimiting_expiry_time_ms":1765372560000,"scope":"application","timeunit":"minute"},"externalValue":null}},"encoding":null}},"links":null},"500":{"description":"Server error","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-server-error":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INTERNAL_SERVER_ERROR","detail":"An unexpected error occurred, please contact support","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"500","title":"Internal Server Error"}]},"externalValue":null}},"encoding":null}},"links":null},"502":{"description":"Bad gateway","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"API gateway error response","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad Gateway"}}}}}},"example":null,"examples":{"error-bad-request":{"summary":null,"description":null,"value":{"message":"Bad Gateway"},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"put":null,"post":null,"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":[{"description":"An OAuth 2.0 bearer token. Required in integration and production environments.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^Bearer [[:ascii:]]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","deprecated":null},"example":null,"examples":null,"content":null,"name":"Authorization","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Unique identifier of this resource","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"24L5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"example":null,"examples":null,"content":null,"name":"id","in":"path","allowEmptyValue":false,"allowReserved":false},{"description":"Unique request identifier, in the format of a GUID","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place.\nThe ID will be returned in a response header.","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false}]},"/mi":{"$ref":null,"summary":null,"description":null,"get":null,"put":null,"post":{"tags":["mi"],"summary":"Create a new MI record","description":"## Overview\n\nUse this endpoint to send management or operational metrics relating to letter processing and print fulfilment.\n\nWhen you submit a create management information request, the endpoint will respond with a 201 (Created) response code along with the created data including a unique id for the record or an unsuccessful (4xx/5xx) response.\n\nRate limiting applies. On excess requests, you may receive **429 Too Many Requests** (example error code(s): `NOTIFY_QUOTA`). Back off and retry later.\n\n## Sandbox test scenarios\n\nYou can test the following scenarios in our sandbox environment.\n\n|Scenario|Request|Response|\n|--------|-------|--------|\n|Success|Request for successful MI record Creation| 201 (Created) with the created management information in the response|\n|Invalid Request|Invalid Request for MI record Creation| 400 (Bad Request) with the error details in the body|\n|Unknown specification|Request for MI record Creation for unknown spec|404 (Not Found)  with the error details in the body|\n","externalDocs":null,"operationId":"createMI","parameters":null,"requestBody":{"description":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"data":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["type","attributes"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["ManagementInformation"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"attributes":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["lineItem","timestamp","quantity"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"lineItem":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A line item reference that should match an invoice line item","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"envelope-business-standard","deprecated":null},"timestamp":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The effective date of the activity being reported","format":"date-time","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2023-11-17T14:27:51.413Z","deprecated":null},"quantity":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"number","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The quantity of the line item being reported","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":22,"deprecated":null},"specificationId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A specification ID provided in the Letter request that this MI relates to","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"da0b1495-c7cb-468c-9d81-07dee089d728","deprecated":null},"groupId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A group ID provided in the Letter request that this MI relates to","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"abc123","deprecated":null},"stockRemaining":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"number","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Stock remaining for this line item, where applicable","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":20000,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"create-mi-request-success":{"summary":"Request for successful MI record Creation","description":null,"value":{"data":{"attributes":{"groupId":"abc123","lineItem":"envelope-business-standard","quantity":22,"specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","stockRemaining":2000,"timestamp":"2023-11-17T14:27:51.413Z"},"type":"ManagementInformation"}},"externalValue":null},"create-mi-request-invalid":{"summary":"Invalid Request for MI record Creation","description":null,"value":{"data":{"attributes":{"groupId":"abc123","lineItem":"envelope-business-standard","quantity":22,"specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","stockRemaining":2000,"timestamp":"yesterday"},"type":"ManagementInformation"}},"externalValue":null},"create-mi-request-notfound":{"summary":"Request for MI record Creation for unknown spec","description":null,"value":{"data":{"attributes":{"groupId":"abc123","lineItem":"envelope-business-standard","quantity":22,"specificationId":"123456","stockRemaining":2000,"timestamp":"2023-11-17T14:27:51.413Z"},"type":"ManagementInformation"}},"externalValue":null}},"encoding":null}},"required":false},"responses":{"201":{"description":"Management Information created successfully","headers":{"X-Request-ID":{"description":"Unique request identifier, in the format of a GUID\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null},"X-Correlation-ID":{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding . characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header.\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null}},"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"data":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["ManagementInformation"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"attributes":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["lineItem","timestamp","quantity"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"lineItem":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A line item reference that should match an invoice line item","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"envelope-business-standard","deprecated":null},"timestamp":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The effective date of the activity being reported","format":"date-time","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2023-11-17T14:27:51.413Z","deprecated":null},"quantity":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"number","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The quantity of the line item being reported","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":22,"deprecated":null},"specificationId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A specification ID provided in the Letter request that this MI relates to","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"da0b1495-c7cb-468c-9d81-07dee089d728","deprecated":null},"groupId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A group ID provided in the Letter request that this MI relates to","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"abc123","deprecated":null},"stockRemaining":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"number","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Stock remaining for this line item, where applicable","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":20000,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"create-mi-response":{"summary":null,"description":null,"value":{"data":{"attributes":{"groupId":"abc123","lineItem":"envelope-business-standard","quantity":22,"specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","stockRemaining":2000,"timestamp":"2023-11-17T14:27:51.413Z"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"ManagementInformation"}},"externalValue":null}},"encoding":null}},"links":null},"400":{"description":"Bad request, invalid input data","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-bad-request":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INVALID_REQUEST","detail":"Invalid request, please refer to the API specifications","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"400","title":"Invalid request"}]},"externalValue":null}},"encoding":null}},"links":null},"429":{"description":"Too many requests","headers":null,"content":{"application/json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Your application has exceeded its quota","deprecated":null},"scope":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"application","deprecated":null},"policy":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"quota","deprecated":null},"limit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":300,"deprecated":null},"interval":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1,"deprecated":null},"timeunit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"minute","deprecated":null},"ratelimiting_expiry_time_ms":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1625498765123,"deprecated":null},"message_id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"rrt-4773181658036170775-c-geu2-321623-73628915-2","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-too-many-requests":{"summary":null,"description":null,"value":{"interval":1,"limit":1,"message":"Your application, Notify-Supplier-App-Restricted - Internal Dev 2, has exceeded its quota of 1 requests every 1 minute(s) and is being rate limited.","message_id":"rrt-4773181658036170775-c-geu2-321623-73628915-2","policy":"quota","ratelimiting_expiry_time_ms":1765372560000,"scope":"application","timeunit":"minute"},"externalValue":null}},"encoding":null}},"links":null},"500":{"description":"Server error","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-server-error":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INTERNAL_SERVER_ERROR","detail":"An unexpected error occurred, please contact support","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"500","title":"Internal Server Error"}]},"externalValue":null}},"encoding":null}},"links":null},"502":{"description":"Bad gateway","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"API gateway error response","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad Gateway"}}}}}},"example":null,"examples":{"error-bad-request":{"summary":null,"description":null,"value":{"message":"Bad Gateway"},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":[{"description":"An OAuth 2.0 bearer token. Required in integration and production environments.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^Bearer [[:ascii:]]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","deprecated":null},"example":null,"examples":null,"content":null,"name":"Authorization","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Unique request identifier, in the format of a GUID","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place.\nThe ID will be returned in a response header.","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false}]},"/mi/{id}":{"$ref":null,"summary":null,"description":null,"get":{"tags":["mi"],"summary":"Fetch an existing MI record","description":"# Overview\n\nUse this endpoint to retrieve management or operational metrics relating to letter processing and print fulfilment.\n\nWhen you submit a get management information request, the endpoint will respond with a 200 (Success) response code along with the created data including a unique id for the record or an unsuccessful (4xx/5xx) response.\n\nRate limiting applies. On excess requests, you may receive **429 Too Many Requests** (example error code(s): `NOTIFY_QUOTA`). Back off and retry later.\n\n## Sandbox test scenarios\n\nYou can test the following scenarios in our sandbox environment.\n\n|Scenario|Request|Response|\n|--------|-------|--------|\n|Success|Request for successful MI record retrieval|200 (Success) with the retrieved management information in the response|\n|Invalid Request|Invalid Request for MI record retrieval|400 (Bad Request) with the error details in the body|\n|Unknown specification|Request for MI record retrieval for unknown spec|404 (Not Found)  with the error details in the body|\n","externalDocs":null,"operationId":"getMI","parameters":null,"requestBody":null,"responses":{"200":{"description":"Management information returned successfully","headers":{"X-Request-ID":{"description":"Unique request identifier, in the format of a GUID\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null},"X-Correlation-ID":{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding . characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header.\n","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null}},"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"data":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["ManagementInformation"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2WL5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"attributes":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["lineItem","timestamp","quantity"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"lineItem":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A line item reference that should match an invoice line item","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"envelope-business-standard","deprecated":null},"timestamp":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The effective date of the activity being reported","format":"date-time","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2023-11-17T14:27:51.413Z","deprecated":null},"quantity":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"number","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The quantity of the line item being reported","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":22,"deprecated":null},"specificationId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A specification ID provided in the Letter request that this MI relates to","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"da0b1495-c7cb-468c-9d81-07dee089d728","deprecated":null},"groupId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A group ID provided in the Letter request that this MI relates to","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"abc123","deprecated":null},"stockRemaining":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"number","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Stock remaining for this line item, where applicable","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":20000,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"get-mi-response":{"summary":null,"description":null,"value":{"data":{"attributes":{"groupId":"abc123","lineItem":"envelope-business-standard","quantity":22,"specificationId":"2WL5eYSWGzCHlGmzNxuqVusPxDg","stockRemaining":2000,"timestamp":"2023-11-17T14:27:51.413Z"},"id":"2WL5eYSWGzCHlGmzNxuqVusPxDg","type":"ManagementInformation"}},"externalValue":null}},"encoding":null}},"links":null},"404":{"description":"Resource not found","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-not-found":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_RESOURCE_NOT_FOUND","detail":"No resource found with that ID","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"404","title":"Resource not found"}]},"externalValue":null}},"encoding":null}},"links":null},"429":{"description":"Too many requests","headers":null,"content":{"application/json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Your application has exceeded its quota","deprecated":null},"scope":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"application","deprecated":null},"policy":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"quota","deprecated":null},"limit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":300,"deprecated":null},"interval":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1,"deprecated":null},"timeunit":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"minute","deprecated":null},"ratelimiting_expiry_time_ms":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1625498765123,"deprecated":null},"message_id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"rrt-4773181658036170775-c-geu2-321623-73628915-2","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-too-many-requests":{"summary":null,"description":null,"value":{"interval":1,"limit":1,"message":"Your application, Notify-Supplier-App-Restricted - Internal Dev 2, has exceeded its quota of 1 requests every 1 minute(s) and is being rate limited.","message_id":"rrt-4773181658036170775-c-geu2-321623-73628915-2","policy":"quota","ratelimiting_expiry_time_ms":1765372560000,"scope":"application","timeunit":"minute"},"externalValue":null}},"encoding":null}},"links":null},"500":{"description":"Server error","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"errors":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["NOTIFY_INTERNAL_SERVER_ERROR","NOTIFY_INVALID_REQUEST","NOTIFY_NOT_FOUND"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"links":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"about":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"status":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"error-server-error":{"summary":null,"description":null,"value":{"errors":[{"code":"NOTIFY_INTERNAL_SERVER_ERROR","detail":"An unexpected error occurred, please contact support","id":"rrt-1931948104716186917-c-geu2-10664-3111479-3.0","links":{"about":"https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"},"status":"500","title":"Internal Server Error"}]},"externalValue":null}},"encoding":null}},"links":null},"502":{"description":"Bad gateway","headers":null,"content":{"application/vnd.api+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"API gateway error response","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad Gateway"}}}}}},"example":null,"examples":{"error-bad-request":{"summary":null,"description":null,"value":{"message":"Bad Gateway"},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"put":null,"post":null,"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":[{"description":"An OAuth 2.0 bearer token. Required in integration and production environments.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^Bearer [[:ascii:]]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","deprecated":null},"example":null,"examples":null,"content":null,"name":"Authorization","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Unique request identifier, in the format of a GUID","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place.\nThe ID will be returned in a response header.","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Unique identifier of this resource","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"24L5eYSWGzCHlGmzNxuqVusPxDg","deprecated":null},"example":null,"examples":null,"content":null,"name":"id","in":"path","allowEmptyValue":false,"allowReserved":false}]},"/_status":{"$ref":null,"summary":null,"description":null,"get":{"tags":null,"summary":"Health check","description":"Returns 200 OK if the service is up.","externalDocs":null,"operationId":"getStatus","parameters":null,"requestBody":null,"responses":{"200":{"description":"Service is healthy","headers":null,"content":null,"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"put":null,"post":null,"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null}},"components":{"schemas":null,"responses":null,"parameters":null,"examples":null,"requestBodies":null,"headers":null,"securitySchemes":{"app-level3":{"$ref":"https://proxygen.prod.api.platform.nhs.uk/components/securitySchemes/app-level3"}},"links":null,"callbacks":null},"security":[{"app-level3":[]}],"tags":[{"name":"letter","description":"","externalDocs":null},{"name":"mi","description":"","externalDocs":null},{"name":"data","description":"","externalDocs":null}],"externalDocs":null,"x-nhsd-apim":null,"x-spec-publication":null}