NPA-5357: Update formatting and API sandbox test

Author: lelliott-hippo

sandbox/api/post_questionnaire_response.py

@@ -10,7 +10,9 @@
 )
 from .utils import generate_response_from_example
 
-QUESTIONNAIRE_RESPONSE_APP_BASE_PATH = "https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse"
+QUESTIONNAIRE_RESPONSE_APP_BASE_PATH = (
+    "https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse"
+)
 basicConfig(level=INFO, format="%(asctime)s - %(message)s")
 logger = getLogger(__name__)
 

sandbox/api/tests/test_post_questionnaire_response.py

@@ -10,38 +10,44 @@
     INTERNAL_SERVER_ERROR_EXAMPLE,
 )
 
+SANDBOX_API_URL = "https://sandbox.api.service.nhs.uk/validated-relationships"
 QUESTIONNAIRE_RESPONSE_API_ENDPOINT = "/FHIR/R4/QuestionnaireResponse"
 
 
 @pytest.mark.parametrize(
-    ("nhs_num", "response_file_name", "status_code"),
+    ("nhs_num", "response_file_name", "status_code", "id"),
     [
         (
             "9000000009",
             POST_QUESTIONNAIRE_RESPONSE__SUCCESS,
             200,
+            "156e1560-e532-4e2a-85ad-5aeff03dc43e",
         ),
         (
             "9000000017",
             POST_QUESTIONNAIRE_RESPONSE__SUCCESS,
             200,
+            "156e1560-e532-4e2a-85ad-5aeff03dc43e",
         ),
         (
             "9000000049",
             POST_QUESTIONNAIRE_RESPONSE__DUPLICATE_RELATIONSHIP_ERROR,
             409,
+            None,
         ),
         (
             "INVALID_NHS_NUMBER",
             INTERNAL_SERVER_ERROR_EXAMPLE,
             500,
+            None,
         ),
     ],
 )
 @patch("sandbox.api.post_questionnaire_response.generate_response_from_example")
 def test_post_questionnaire_response(
     mock_generate_response_from_example: MagicMock,
     nhs_num: str,
+    id: str,
     response_file_name: str,
     status_code: int,
     client: object,
@@ -57,6 +63,13 @@ def test_post_questionnaire_response(
     # Act
     response = client.post(QUESTIONNAIRE_RESPONSE_API_ENDPOINT, json=json)
     # Assert
-    mock_generate_response_from_example.assert_called_once_with(response_file_name, status_code)
+    if id is not None:
+        mock_generate_response_from_example.assert_called_once_with(
+            response_file_name,
+            status_code,
+            headers={"location": f"{SANDBOX_API_URL}{QUESTIONNAIRE_RESPONSE_API_ENDPOINT}?ID={id}"},
+        )
+    else:
+        mock_generate_response_from_example.assert_called_once_with(response_file_name, status_code)
     assert response.status_code == status_code
     assert response.json == loads(mocked_response.get_data(as_text=True))

specification/examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml

@@ -1,6 +1,6 @@
 QuestionnaireResponseNotFound:
   summary: Questionnaire response not found
-  description: The Questionnaire response could not be found using the provided access request UUID.
+  description: The Questionnaire response could not be found using the provided access request ID.
   value:
     resourceType: "OperationOutcome"
     issue:

specification/validated-relationships-service-api.yaml

@@ -298,11 +298,11 @@ paths:
       summary: Get a proxy access request
       description: |
         ## Overview
-        Retrieve a QuestionnaireResponse using its unique access request UUID. This endpoint returns the full
+        Retrieve a QuestionnaireResponse using its unique access request ID. This endpoint returns the full
         QuestionnaireResponse document that was previously submitted.
 
         ## Request Requirements
-        A valid access request UUID must be provided as a query parameter. This access request UUID is returned
+        A valid access request ID must be provided as a query parameter. This access request ID is returned
         when a QuestionnaireResponse is initially submitted via the POST endpoint.
 
         ## Access modes