Skip to content

Commit 624906e

Browse files
committed
test data specification and minor at tweaks
1 parent df988b4 commit 624906e

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

docs/collections/_consumers/acceptance.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,21 @@ NHS Notify will seed your Integration (INT) environment with a sample of 2,500 l
3535

3636
The seeded dataset provides a mix of standard and exceptional cases to validate your system's ability to process, identify, and report on different letter types and outcomes.
3737

38-
The sample data will include:
38+
We use the specification to define the format in which letters should be produced.  An Example of the full range of specifications is:
3939

4040
- Standard letters (English) - Core test cases representing typical production letters in standard format and layout
4141
- Accessible format letters - Letters designed for accessibility (e.g., large print, braille, or audio) to ensure your system correctly identifies and routes alternative format requests
42-
- Letters without PDFs - Records that reference missing or unavailable PDF files, used to test your system's error handling and reporting for incomplete data
43-
- Incorrect letter specifications - Letters containing invalid or incomplete metadata to validate error detection and response handling
44-
- Non-English letters – Right-to-Left (RTL) - Examples in languages that read from right to left (e.g., Arabic, Urdu) to test layout handling
42+
- Letters without PDFs - Records that reference missing or unavailable PDF files, used to test your systems error handling and reporting for incomplete data
43+
- Incorrect letter specifications - Letters containing invalid or incomplete metadata  to validate error detection and response handling
44+
- Non-English letters – Right-to-Left (RTL) -  Examples in languages that read from right to left (e.g., Arabic, Urdu) to test layout handling
4545
- Non-English letters – Left-to-Right (LTR) - Examples in other supported non-English languages
4646

47+
As part of the seeded test data will provide multiple specifications to simulate the above scenarios (Note: the linked PDF data may be a standard English test document):
48+
49+
integration-specification-english
50+
integration-specification-braille
51+
integration-specification-arabic
52+
4753
### Purpose of the Test Data
4854

4955
This data allows you to:
@@ -429,7 +435,7 @@ Demonstrate that your system:
429435

430436
| Criteria | Description |
431437
|---|---|
432-
| **Steps** | 1. Read the provided list of letter IDs to be cancelled <br>2. Send a PATCH /letters/{id} request to update targeted letters to CANCELLED or send a POST /letters for a bulk update<br>3. Verify via GET /letters/{id} that status updated to CANCELLED. |
438+
| **Steps** | 1. Select list of letter IDs to be cancelled <br>2. Send a PATCH /letters/{id} request to update targeted letters to CANCELLED or send a POST /letters for a bulk update<br>3. Verify via GET /letters/{id} that status updated to CANCELLED. |
433439
| **Acceptance** | - Only letters not yet dispatched or delivered may be cancelled<br>- All targeted letters are successfully updated to CANCELLED<br>- API returns a successful response. |
434440
| **Evidence** | API audit trail and before/after validation samples. <br> For this test, the key evidence is that you can notify us once your internal cancellation process is complete and that the API correctly reflects those cancellations. The test is not about the cancellation business process itself. |
435441
| **Business value** | Confirms that suppliers can reliably report letter cancellations to NHS Notify once they have been actioned internally, supporting accurate lifecycle tracking and preparing the foundation for a future automated cancellation integration. |
@@ -528,7 +534,7 @@ This test verifies that your system can submit accurate, complete MI that matche
528534
**Business outcome:**
529535
NHS Notify uses MI data for reconciliation, billing, and operational assurance. You must ensure each submission represents a unique data set and does not duplicate previous entries.
530536

531-
A duplicate MI entry is identified when multiple submissions are received with the same combination of reporting date and specification reference for the same groupID.
537+
A duplicate MI entry is identified when multiple submissions are received with the same combination of reporting date and specification reference for the same groupID.
532538

533539
**Endpoints:**
534540

0 commit comments

Comments
 (0)