You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/collections/_consumers/acceptance.md
+12-6Lines changed: 12 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,15 +35,21 @@ NHS Notify will seed your Integration (INT) environment with a sample of 2,500 l
35
35
36
36
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.
37
37
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:
39
39
40
40
- Standard letters (English) - Core test cases representing typical production letters in standard format and layout
41
41
- 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 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
45
45
- Non-English letters – Left-to-Right (LTR) - Examples in other supported non-English languages
46
46
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
+
47
53
### Purpose of the Test Data
48
54
49
55
This data allows you to:
@@ -429,7 +435,7 @@ Demonstrate that your system:
429
435
430
436
| Criteria | Description |
431
437
|---|---|
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. |
433
439
|**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. |
434
440
|**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. |
435
441
|**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
528
534
**Business outcome:**
529
535
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.
530
536
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.
0 commit comments