Skip to content

Commit a98228f

Browse files
NPA-5357: Update Postman collection
1 parent ab0e2e0 commit a98228f

File tree

2 files changed

+42
-34
lines changed

2 files changed

+42
-34
lines changed

postman/Validate Relationship Service Sandbox.postman_collection.json

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
{
22
"info": {
3-
"_postman_id": "a676026f-cba5-4d4e-a36b-7c78a9382f49",
4-
"name": "Validate Relationship Service Sandbox 10/07/25",
3+
"_postman_id": "a6b9c818-8ca6-4702-97ed-c6336703f7fc",
4+
"name": "Validate Relationship Service Sandbox 12/08/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": "18067099"
7+
"_exporter_id": "45653607",
8+
"_collection_link": "https://www.postman.com/lukeelliott-8674106/workspace/validated-relationship-service-sandbox-12-08-2025/collection/45653607-a6b9c818-8ca6-4702-97ed-c6336703f7fc?action=share&source=collection_link&creator=45653607"
89
},
910
"item": [
1011
{
@@ -230,7 +231,7 @@
230231
}
231232
],
232233
"url": {
233-
"raw": "{{api_base_url}}/QuestionnaireResponse?referenceCode=19318ZGLAB",
234+
"raw": "{{api_base_url}}/QuestionnaireResponse?accessRequestUUID=156e1560-e532-4e2a-85ad-5aeff03dc43e",
234235
"host": [
235236
"{{api_base_url}}"
236237
],
@@ -239,8 +240,8 @@
239240
],
240241
"query": [
241242
{
242-
"key": "referenceCode",
243-
"value": "19318ZGLAB"
243+
"key": "accessRequestUUID",
244+
"value": "156e1560-e532-4e2a-85ad-5aeff03dc43e"
244245
}
245246
]
246247
},
@@ -249,7 +250,7 @@
249250
"response": []
250251
},
251252
{
252-
"name": "Missing Reference Code",
253+
"name": "Missing accessRequestUUID",
253254
"event": [
254255
{
255256
"listen": "test",
@@ -264,13 +265,13 @@
264265
" \"details\": {",
265266
" \"coding\": [",
266267
" {",
267-
" \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",",
268-
" \"code\": \"MISSING_REFERENCE_CODE\",",
269-
" \"display\": \"Missing reference code\"",
268+
" \"system\": \"https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1\",",
269+
" \"code\": \"BAD_REQUEST\",",
270+
" \"display\": \"Bad request\"",
270271
" }",
271272
" ]",
272273
" },",
273-
" \"diagnostics\": \"The reference code parameter is required but was not provided.\"",
274+
" \"diagnostics\": \"The access request UUID parameter is required but was not provided.\"",
274275
" }",
275276
" ]",
276277
"};",
@@ -317,7 +318,7 @@
317318
"response": []
318319
},
319320
{
320-
"name": "Invalid Reference Code",
321+
"name": "Invalid accessRequestUUID",
321322
"event": [
322323
{
323324
"listen": "test",
@@ -332,13 +333,13 @@
332333
" \"details\": {",
333334
" \"coding\": [",
334335
" {",
335-
" \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",",
336-
" \"code\": \"INVALID_REFERENCE_CODE\",",
337-
" \"display\": \"Invalid reference code\"",
336+
" \"system\": \"https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1\",",
337+
" \"code\": \"INVALID_IDENTIFIER_VALUE\",",
338+
" \"display\": \"Invalid identifier value\"",
338339
" }",
339340
" ]",
340341
" },",
341-
" \"diagnostics\": \"The specified reference code format is invalid. Reference codes must be alphanumeric.\"",
342+
" \"diagnostics\": \"The specified access request UUID is invalid. Access request UUIDs must be a valid UUID.\"",
342343
" }",
343344
" ]",
344345
"};",
@@ -355,6 +356,13 @@
355356
"type": "text/javascript",
356357
"packages": {}
357358
}
359+
},
360+
{
361+
"listen": "prerequest",
362+
"script": {
363+
"packages": {},
364+
"type": "text/javascript"
365+
}
358366
}
359367
],
360368
"request": {
@@ -372,7 +380,7 @@
372380
}
373381
],
374382
"url": {
375-
"raw": "{{api_base_url}}/QuestionnaireResponse?referenceCode=INVALID",
383+
"raw": "{{api_base_url}}/QuestionnaireResponse?accessRequestUUID=INVALID",
376384
"host": [
377385
"{{api_base_url}}"
378386
],
@@ -381,7 +389,7 @@
381389
],
382390
"query": [
383391
{
384-
"key": "referenceCode",
392+
"key": "accessRequestUUID",
385393
"value": "INVALID"
386394
}
387395
]
@@ -391,7 +399,7 @@
391399
"response": []
392400
},
393401
{
394-
"name": "Reference Code Not Found",
402+
"name": "accessRequestUUID not found",
395403
"event": [
396404
{
397405
"listen": "test",
@@ -406,13 +414,13 @@
406414
" \"details\": {",
407415
" \"coding\": [",
408416
" {",
409-
" \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",",
417+
" \"system\": \"https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1\",",
410418
" \"code\": \"QUESTIONNAIRE_RESPONSE_NOT_FOUND\",",
411419
" \"display\": \"Questionnaire response not found\"",
412420
" }",
413421
" ]",
414422
" },",
415-
" \"diagnostics\": \"The Questionnaire response could not be found using the provided reference code.\"",
423+
" \"diagnostics\": \"The Questionnaire response could not be found using the provided access request UUID.\"",
416424
" }",
417425
" ]",
418426
"};",
@@ -446,7 +454,7 @@
446454
}
447455
],
448456
"url": {
449-
"raw": "{{api_base_url}}/QuestionnaireResponse?referenceCode=ABC123XY",
457+
"raw": "{{api_base_url}}/QuestionnaireResponse?accessRequestUUID=60d09b82-f4bb-41f9-b41e-767999b4ac9b",
450458
"host": [
451459
"{{api_base_url}}"
452460
],
@@ -455,8 +463,8 @@
455463
],
456464
"query": [
457465
{
458-
"key": "referenceCode",
459-
"value": "ABC123XY"
466+
"key": "accessRequestUUID",
467+
"value": "60d09b82-f4bb-41f9-b41e-767999b4ac9b"
460468
}
461469
]
462470
},
@@ -486,8 +494,8 @@
486494
" \"details\": {",
487495
" \"coding\": [",
488496
" {",
489-
" \"code\": \"19318ZGLAB\",",
490-
" \"display\": \"19318ZGLAB\"",
497+
" \"code\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\",",
498+
" \"display\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\"",
491499
" }",
492500
" ]",
493501
" }",
@@ -566,8 +574,8 @@
566574
" \"details\": {",
567575
" \"coding\": [",
568576
" {",
569-
" \"code\": \"19318ZGLAB\",",
570-
" \"display\": \"19318ZGLAB\"",
577+
" \"code\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\",",
578+
" \"display\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\"",
571579
" }",
572580
" ]",
573581
" }",
@@ -712,8 +720,8 @@
712720
" \"details\": {",
713721
" \"coding\": [",
714722
" {",
715-
" \"code\": \"19318ZGLAB\",",
716-
" \"display\": \"19318ZGLAB\"",
723+
" \"code\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\",",
724+
" \"display\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\"",
717725
" }",
718726
" ]",
719727
" }",
@@ -791,8 +799,8 @@
791799
" \"details\": {",
792800
" \"coding\": [",
793801
" {",
794-
" \"code\": \"19318ZGLAB\",",
795-
" \"display\": \"19318ZGLAB\"",
802+
" \"code\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\",",
803+
" \"display\": \"156e1560-e532-4e2a-85ad-5aeff03dc43e\"",
796804
" }",
797805
" ]",
798806
" }",
@@ -10288,4 +10296,4 @@
1028810296
"type": "string"
1028910297
}
1029010298
]
10291-
}
10299+
}

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://god.gw.postman.com/run-collection/46399153-73a3846c-092a-44a1-940f-18736fb1f411?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D46399153-73a3846c-092a-44a1-940f-18736fb1f411%26entityType%3Dcollection%26workspaceId%3D34c06bc9-c5de-4206-b931-9ee51c810dbb))
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-a6b9c818-8ca6-4702-97ed-c6336703f7fc?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D45653607-a6b9c818-8ca6-4702-97ed-c6336703f7fc%26entityType%3Dcollection%26workspaceId%3D56b0e630-7170-4007-a896-520a5ed50164))
145145
146146
### Integration testing
147147

0 commit comments

Comments
 (0)