NHnhs
data

Fetch a data file

Overview

Use this endpoint to get letter data, including downloading the letter's print-ready PDF file.

Rate limiting applies. On excess requests, you may receive 429 Too Many Requests (example error code(s): NOTIFY_QUOTA). Back off and retry later.

Sandbox test scenarios

You can test the following scenarios in our sandbox environment.

ScenarioRequest IDResponse
Success2AL5eYSWGzCHlGmzNxuqVusPxDgReturns 303 (See Other) and URL to an example PDF in the Location header
Not found2WL5eYSWGzCHlGmzNxuqVusPxDgReturns 404 Not found and error details in the response
get/letters/{id}/data

Request

  • Base URL
    https://internal-dev-sandbox.api.service.nhs.uk/nhs-notify-supplier
  • URL
    https://internal-dev-sandbox.api.service.nhs.uk/nhs-notify-supplier/letters/{id}/data
  • Auth
    none required

Changes

No recorded changes to this operation across all 1 revision of this API.