Skip to content

Commit f33895f

Browse files
NPA-5357: Postman update
1 parent d1d0890 commit f33895f

File tree

2 files changed

+60
-40
lines changed

2 files changed

+60
-40
lines changed

postman/Validate Relationship Service Sandbox.postman_collection.json renamed to postman/Validated Relationship Service Sandbox.postman_collection.json

Lines changed: 59 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"info": {
3-
"_postman_id": "298358e5-ad8f-4875-a8e3-acb4600712f0",
4-
"name": "Validated Relationship Service Sandbox 03/09/25",
3+
"_postman_id": "66c6bd03-3fda-4ff7-9be9-bace275b60cf",
4+
"name": "Validated Relationship Service Sandbox 08/09/25",
55
"description": "This Postman collection includes example scenarios for each of the Validated Relationship Service (VRS) API endpoints, covering both valid and invalid request scenarios.\n\nThe collection is pointed towards the VRS sandbox environment, which will return a specific example response based on the request sent. All data shown in the requests or responses is test data.\n\nOur sandbox environment only covers the scenarios listed in the Postman collection and is open access. It does not allow you to test authorisation or any scenarios beyond the ones documented.\n\nFull specification is available at [https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service](https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service)",
66
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
7-
"_exporter_id": "34042403",
8-
"_collection_link": "https://www.postman.com/jackplowman2/workspace/validate-relationship-service-sandbox-03-09-25/collection/34042403-298358e5-ad8f-4875-a8e3-acb4600712f0?action=share&source=collection_link&creator=34042403"
7+
"_exporter_id": "45653607",
8+
"_collection_link": "https://www.postman.com/lukeelliott-8674106/workspace/validated-relationship-service-sandbox-08-11-2025/collection/45653607-66c6bd03-3fda-4ff7-9be9-bace275b60cf?action=share&source=collection_link&creator=45653607"
99
},
1010
"item": [
1111
{
@@ -22,6 +22,10 @@
2222
" \"resourceType\": \"QuestionnaireResponse\",",
2323
" \"status\": \"completed\",",
2424
" \"authored\": \"2024-07-15T09:43:03.280Z\",",
25+
" \"id\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\",",
26+
" \"identifier\": {",
27+
" \"value\": \"19318ZGLAB\"",
28+
" },",
2529
" \"source\": {",
2630
" \"type\": \"RelatedPerson\",",
2731
" \"identifier\": {",
@@ -250,7 +254,7 @@
250254
"response": []
251255
},
252256
{
253-
"name": "Missing Reference Code",
257+
"name": "Missing Access Request UUID",
254258
"event": [
255259
{
256260
"listen": "test",
@@ -318,31 +322,31 @@
318322
"response": []
319323
},
320324
{
321-
"name": "Invalid Reference Code",
325+
"name": "Invalid Access Request UUID",
322326
"event": [
323327
{
324328
"listen": "test",
325329
"script": {
326330
"exec": [
327331
"const expectedResponseBody = {",
328-
" \"resourceType\": \"OperationOutcome\",",
329-
" \"issue\": [",
330-
" {",
331-
" \"severity\": \"error\",",
332-
" \"code\": \"required\",",
333-
" \"details\": {",
334-
" \"coding\": [",
335-
" {",
336-
" \"system\": \"https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1\",",
337-
" \"code\": \"BAD_REQUEST\",",
338-
" \"display\": \"Bad request\"",
339-
" }",
340-
" ]",
341-
" },",
342-
" \"diagnostics\": \"The access request ID parameter is required but was not provided.\"",
343-
" }",
344-
" ]",
345-
"};",
332+
" \"resourceType\": \"OperationOutcome\",",
333+
" \"issue\": [",
334+
" {",
335+
" \"severity\": \"error\",",
336+
" \"code\": \"invalid\",",
337+
" \"details\": {",
338+
" \"coding\": [",
339+
" {",
340+
" \"system\": \"https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1\",",
341+
" \"code\": \"INVALID_IDENTIFIER_VALUE\",",
342+
" \"display\": \"Invalid identifier value\",",
343+
" }",
344+
" ]",
345+
" },",
346+
" \"diagnostics\": \"The specified access request ID is invalid. Access request IDs must be a valid UUID.\",",
347+
" }",
348+
" ],",
349+
" };",
346350
"",
347351
"pm.test(\"Status code is 400\", function () {",
348352
" pm.response.to.have.status(400);",
@@ -373,7 +377,7 @@
373377
}
374378
],
375379
"url": {
376-
"raw": "{{api_base_url}}/QuestionnaireResponse?referenceCode=INVALID",
380+
"raw": "{{api_base_url}}/QuestionnaireResponse?ID=INVALID",
377381
"host": [
378382
"{{api_base_url}}"
379383
],
@@ -382,7 +386,7 @@
382386
],
383387
"query": [
384388
{
385-
"key": "referenceCode",
389+
"key": "ID",
386390
"value": "INVALID"
387391
}
388392
]
@@ -392,7 +396,7 @@
392396
"response": []
393397
},
394398
{
395-
"name": "Reference Code Not Found",
399+
"name": "Access Request UUID Not Found",
396400
"event": [
397401
{
398402
"listen": "test",
@@ -487,8 +491,8 @@
487491
" \"details\": {",
488492
" \"coding\": [",
489493
" {",
490-
" \"code\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\",",
491-
" \"display\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\"",
494+
" \"code\": \"19318ZGLAB\",",
495+
" \"display\": \"19318ZGLAB\"",
492496
" }",
493497
" ]",
494498
" }",
@@ -503,7 +507,11 @@
503507
"pm.test(\"Response has the correct body\", () => {",
504508
" const responseJson = pm.response.json();",
505509
" pm.expect(responseJson).to.eql(expectedResponseBody);",
506-
"});"
510+
"});",
511+
"",
512+
"pm.test(\"Location header is returned\", () => {",
513+
" pm.response.to.have.header(\"Location\", \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse?ID=156e1560-e532-4e2a-85ad-5aeff03dc43e\")",
514+
"})"
507515
],
508516
"type": "text/javascript",
509517
"packages": {}
@@ -567,8 +575,8 @@
567575
" \"details\": {",
568576
" \"coding\": [",
569577
" {",
570-
" \"code\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\",",
571-
" \"display\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\"",
578+
" \"code\": \"19318ZGLAB\",",
579+
" \"display\": \"19318ZGLAB\"",
572580
" }",
573581
" ]",
574582
" }",
@@ -583,7 +591,11 @@
583591
"pm.test(\"Response has the correct body\", () => {",
584592
" const responseJson = pm.response.json();",
585593
" pm.expect(responseJson).to.eql(expectedResponseBody);",
586-
"});"
594+
"});",
595+
"",
596+
"pm.test(\"Location header is returned\", () => {",
597+
" pm.response.to.have.header(\"Location\", \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse?ID=156e1560-e532-4e2a-85ad-5aeff03dc43e\")",
598+
"})"
587599
],
588600
"type": "text/javascript",
589601
"packages": {}
@@ -713,8 +725,8 @@
713725
" \"details\": {",
714726
" \"coding\": [",
715727
" {",
716-
" \"code\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\",",
717-
" \"display\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\"",
728+
" \"code\": \"19318ZGLAB\",",
729+
" \"display\": \"19318ZGLAB\"",
718730
" }",
719731
" ]",
720732
" }",
@@ -729,7 +741,11 @@
729741
"pm.test(\"Response has the correct body\", () => {",
730742
" const responseJson = pm.response.json();",
731743
" pm.expect(responseJson).to.eql(expectedResponseBody);",
732-
"});"
744+
"});",
745+
"",
746+
"pm.test(\"Location header is returned\", () => {",
747+
" pm.response.to.have.header(\"Location\", \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse?ID=156e1560-e532-4e2a-85ad-5aeff03dc43e\")",
748+
"})"
733749
],
734750
"type": "text/javascript",
735751
"packages": {}
@@ -792,8 +808,8 @@
792808
" \"details\": {",
793809
" \"coding\": [",
794810
" {",
795-
" \"code\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\",",
796-
" \"display\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\"",
811+
" \"code\": \"19318ZGLAB\",",
812+
" \"display\": \"19318ZGLAB\"",
797813
" }",
798814
" ]",
799815
" }",
@@ -808,7 +824,11 @@
808824
"pm.test(\"Response has the correct body\", () => {",
809825
" const responseJson = pm.response.json();",
810826
" pm.expect(responseJson).to.eql(expectedResponseBody);",
811-
"});"
827+
"});",
828+
"",
829+
"pm.test(\"Location header is returned\", () => {",
830+
" pm.response.to.have.header(\"Location\", \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse?ID=156e1560-e532-4e2a-85ad-5aeff03dc43e\")",
831+
"})"
812832
],
813833
"type": "text/javascript",
814834
"packages": {}

specification/validated-relationships-service-api.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ info:
141141
* only covers a limited set of scenarios
142142
* is open access, so does not allow you to test authorisation
143143
144-
[<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://app.getpostman.com/run-collection/34042403-298358e5-ad8f-4875-a8e3-acb4600712f0?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D34042403-298358e5-ad8f-4875-a8e3-acb4600712f0%26entityType%3Dcollection%26workspaceId%3D0e2260b3-ef5a-4ac7-a458-4fea08d8b726)
144+
[<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/45653607-66c6bd03-3fda-4ff7-9be9-bace275b60cf?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D45653607-66c6bd03-3fda-4ff7-9be9-bace275b60cf%26entityType%3Dcollection%26workspaceId%3Dbd95b9f9-f9b0-4f1f-958a-2f6822c182c1)
145145
146146
### Integration testing
147147

0 commit comments

Comments
 (0)