Skip to content

Commit 5f85a17

Browse files
committed
NPA-5136: add MISSING_VALUE and INVALID_VALUE to all endpoints
1 parent 24a33c6 commit 5f85a17

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

specification/validated-relationships-service-api.yaml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,8 @@ paths:
248248
| ----------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
249249
| 400 | `BAD_REQUEST` | Bad request. |
250250
| 400 | `NOT_SUPPORTED` | The request is not currently supported. |
251+
| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |
252+
| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |
251253
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
252254
| 403 | `FORBIDDEN` | Access denied to resource. |
253255
| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |
@@ -334,7 +336,9 @@ paths:
334336
| HTTP status | Error code | Description |
335337
| ----------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
336338
| 400 | `INVALID_REFERENCE_CODE` | The reference code must be alphanumeric and exactly 10 characters long. |
339+
| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |
337340
| 400 | `MISSING_REFERENCE_CODE` | The reference code is required but was not provided in the request. |
341+
| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |
338342
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
339343
| 403 | `FORBIDDEN` | Access denied to resource. |
340344
| 404 | `QUESTIONNAIRE_RESPONSE_NOT_FOUND` | No questionnaire response was found for the provided reference code. |
@@ -396,8 +400,8 @@ paths:
396400
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- |
397401
| List Relationship | `identifier`=`9000000017` | HTTP Status 200 List of relationships for the proxy |
398402
| List Relationship and include patient's details | `identifier`=`9000000017` and `_include`=`RelatedPerson:patient` | HTTP Status 200 List of relationships for the proxy and includes patient data |
399-
| List Patient Relationship | `patient:identifier`=`9000000042` | HTTP Status 200 List of relationships for the patient |
400-
| List Patient Relationship and include patient's details | `patient:identifier`=`9000000042` and `_include`=`RelatedPerson:patient` | HTTP Status 200 List of relationships for the patient and includes proxy data |
403+
| List Patient Relationship | `patient:identifier`=`9000000042` | HTTP Status 200 List of relationships for the patient |
404+
| List Patient Relationship and include patient's details | `patient:identifier`=`9000000042` and `_include`=`RelatedPerson:patient` | HTTP Status 200 List of relationships for the patient and includes proxy data |
401405
| List Relationship and no relationships returned | `identifier`=`9000000033` | HTTP Status 200 Empty bundle |
402406
| Verify Relationship between proxy and patient | `identifier`=`9000000017` and `patient:identifier`=`9000000009` | HTTP Status 200 Verified relationship between patient and proxy |
403407
| Verify Relationship between proxy and patient and include patient's details | `identifier`=`9000000017` and `patient:identifier`=`9000000009` and `_include`=`RelatedPerson:patient` | HTTP Status 200 Verified relationship between patient and proxy and includes patient's details |
@@ -456,7 +460,9 @@ paths:
456460
| HTTP status | Error code | Description |
457461
| ----------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
458462
| 400 | `INVALID_IDENTIFIER_SYSTEM` | Invalid identifier system. |
463+
| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |
459464
| 400 | `MISSING_IDENTIFIER_VALUE` | Missing RelatedPerson NHS number. |
465+
| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |
460466
| 400 | `INVALID_IDENTIFIER_VALUE` | Malformed RelatedPerson NHS number. |
461467
| 400 | `INVALID_PATIENT_IDENTIFIER_VALUE` | Malformed Patient NHS number. |
462468
| 400 | `NOT_SUPPORTED` | The request is not currently supported. |
@@ -714,6 +720,7 @@ paths:
714720
715721
| HTTP status | Error code | Description |
716722
| ----------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
723+
| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |
717724
| 400 | `MISSING_IDENTIFIER_VALUE` | Missing performer or patient identifier. |
718725
| 400 | `MISSING_IDENTIFIER_SYSTEM` | Missing performer or patient identifier system. |
719726
| 400 | `MISSING_PATIENT` | Missing patient. |
@@ -722,6 +729,7 @@ paths:
722729
| 400 | `MISSING_SCOPE` | Missing scope. |
723730
| 400 | `MISSING_CATEGORY` | Missing category. |
724731
| 400 | `MISSING_DATETIME` | Missing datetime. |
732+
| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |
725733
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
726734
| 403 | `FORBIDDEN` | Access denied to resource. |
727735
| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |
@@ -850,6 +858,8 @@ paths:
850858
| HTTP status | Error code | Description |
851859
| ----------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
852860
| 400 | `NOT_SUPPORTED` | The request is not currently supported. |
861+
| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |
862+
| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |
853863
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
854864
| 403 | `FORBIDDEN` | Access denied to resource. |
855865
| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |
@@ -988,6 +998,7 @@ paths:
988998
| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |
989999
| 400 | `INVALID_PATCH_FORMAT` | Invalid patch format. |
9901000
| 400 | `INVALID_PATCH` | Invalid patch. |
1001+
| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |
9911002
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
9921003
| 403 | `FORBIDDEN` | Access denied to resource. |
9931004
| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |

0 commit comments

Comments
 (0)