Skip to content

Commit 0a083aa

Browse files
nhsd-david-wassnhsd-david-wass
committed
Update sandbox and OAS descriptions
1 parent 740bc69 commit 0a083aa

File tree

11 files changed

+65
-14
lines changed

11 files changed

+65
-14
lines changed

‎sandbox/data/examples/patchLetter/requests/patchLetter_CANCELLED.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"data": {
33
"attributes": {
4-
"reasonCode": "R01",
5-
"reasonText": "failed validation",
4+
"reasonCode": "R10",
5+
"reasonText": "Miscellaneous",
66
"status": "CANCELLED"
77
},
88
"id": "2WL5eYSWGzCHlGmzNxuqVusPxDg",

‎sandbox/data/examples/patchLetter/requests/patchLetter_FAILED.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"data": {
33
"attributes": {
4-
"reasonCode": "R01",
5-
"reasonText": "failed validation",
4+
"reasonCode": "R10",
5+
"reasonText": "Miscellaneous",
66
"status": "FAILED"
77
},
88
"id": "2WL5eYSWGzCHlGmzNxuqVusPxDg",

‎sandbox/data/examples/patchLetter/requests/patchLetter_REJECTED.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"data": {
33
"attributes": {
4-
"reasonCode": "R01",
5-
"reasonText": "failed validation",
4+
"reasonCode": "R07",
5+
"reasonText": "No such address",
66
"status": "REJECTED"
77
},
88
"id": "2WL5eYSWGzCHlGmzNxuqVusPxDg",

‎sandbox/data/examples/patchLetter/requests/patchLetter_RETURNED.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"data": {
33
"attributes": {
44
"reasonCode": "R01",
5-
"reasonText": "failed validation",
5+
"reasonText": "Addressee gone away",
66
"status": "REJECTED"
77
},
88
"id": "2WL5eYSWGzCHlGmzNxuqVusPxDg",

‎sandbox/data/examples/patchLetter/responses/patchLetter_CANCELLED.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"data": {
33
"attributes": {
4-
"reasonCode": "R01",
5-
"reasonText": "failed validation",
4+
"reasonCode": "R10",
5+
"reasonText": "Miscellaneous",
66
"specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
77
"status": "CANCELLED"
88
},

‎sandbox/data/examples/patchLetter/responses/patchLetter_FAILED.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"data": {
33
"attributes": {
4-
"reasonCode": "R01",
5-
"reasonText": "failed validation",
4+
"reasonCode": "R10",
5+
"reasonText": "Miscellaneous",
66
"specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
77
"status": "FAILED"
88
},

‎sandbox/data/examples/patchLetter/responses/patchLetter_REJECTED.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"data": {
33
"attributes": {
4-
"reasonCode": "R01",
5-
"reasonText": "failed validation",
4+
"reasonCode": "R07",
5+
"reasonText": "No such address",
66
"specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
77
"status": "REJECTED"
88
},

‎sandbox/data/examples/patchLetter/responses/patchLetter_RETURNED.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"data": {
33
"attributes": {
44
"reasonCode": "R01",
5-
"reasonText": "failed validation",
5+
"reasonText": "Addressee gone away",
66
"specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
77
"status": "RETURNED"
88
},

‎specification/api/components/documentation/getLetterStatus.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,20 @@ You can test the following scenarios in our sandbox environment
2020
| Retrieve a CANCELLED letter status | `2XL5eYSWGzCHlGmzNxuqVusPxDg`|
2121
| Retrieve a FAILED letter status | `2YL5eYSWGzCHlGmzNxuqVusPxDg`|
2222
| Retrieve a RETURNED letter status | `2ZL5eYSWGzCHlGmzNxuqVusPxDg`|
23+
24+
### Example Error Codes
25+
26+
Examples of reason codes and text that may be returned include (but are not limited to)
27+
28+
| Reason Code | Reason Text |
29+
|-------------|----------------------------|
30+
|R01 |Addressee gone away |
31+
|R02 |Address incomplete |
32+
|R03 |Address inaccessible |
33+
|R04 |Addressee unknown |
34+
|R05 |Addressee gone away/Refused |
35+
|R06 |Not called for |
36+
|R07 |No such address |
37+
|R08 |No reason given |
38+
|R09 |Deceased |
39+
|R10 |Miscellaneous |

‎specification/api/components/documentation/patchLetter.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,20 @@ Allowed `status` values that can be used to are:
2424
It is not possible to update a letter to status of `PENDING`.
2525

2626
Optionally a `reasonCode` and `reasonText` explaining the status (for example, validation failures) can be included in the request body.
27+
28+
### Example Error Codes
29+
30+
Examples of reason codes and text that may be returned include (but are not limited to)
31+
32+
| Reason Code | Reason Text |
33+
|-------------|----------------------------|
34+
|R01 |Addressee gone away |
35+
|R02 |Address incomplete |
36+
|R03 |Address inaccessible |
37+
|R04 |Addressee unknown |
38+
|R05 |Addressee gone away/Refused |
39+
|R06 |Not called for |
40+
|R07 |No such address |
41+
|R08 |No reason given |
42+
|R09 |Deceased |
43+
|R10 |Miscellaneous |

0 commit comments

Comments
 (0)