NPA-4689 Add GET /QuestionnaireResponse endpoint to Sandbox

Author: JackPlowman

sandbox/api/app.py

@@ -4,6 +4,7 @@
 from flask import Flask
 
 from .get_consent import get_consent_response
+from .get_questionnaire_response import get_questionnaire_response_response
 from .get_related_person import get_related_person_response
 from .patch_consent import patch_consent_response
 from .post_consent import post_consent_response
@@ -37,6 +38,16 @@ def get_related_persons() -> Union[dict, tuple]:
     return get_related_person_response()
 
 
+@app.route(f"/{COMMON_PATH}/QuestionnaireResponse", methods=["GET"])
+def get_questionnaire_response() -> Union[dict, tuple]:
+    """Sandbox API for GET /QuestionnaireResponse
+
+    Returns:
+        Union[dict, tuple]: Response for GET /QuestionnaireResponse
+    """
+    return get_questionnaire_response_response()
+
+
 @app.route(f"/{COMMON_PATH}/QuestionnaireResponse", methods=["POST"])
 def post_questionnaire_response() -> Union[dict, tuple]:
     """Sandbox API for POST /QuestionnaireResponse

sandbox/api/constants.py

@@ -62,9 +62,15 @@
 PATCH_CONSENT__RESOURCE_NOT_FOUND = f"{PATCH_CONSENT__DIRECTORY}errors/resource_not_found.yaml"
 PATCH_CONSENT__INVALID_STATE_TRANSITION = f"{PATCH_CONSENT__DIRECTORY}errors/invalid_state_transition.yaml"
 
-QR_DIRECTORY = "./api/examples/POST_QuestionnaireResponse/"
-QUESTIONNAIRE_RESPONSE__SUCCESS = f"{QR_DIRECTORY}success.yaml"
+# POST QuestionnaireResponse
+POST_QUESTIONNAIRE_RESPONSE_DIRECTORY = "./api/examples/POST_QuestionnaireResponse/"
+POST_QUESTIONNAIRE_RESPONSE__SUCCESS = f"{POST_QUESTIONNAIRE_RESPONSE_DIRECTORY}success.yaml"
 
+# GET QuestionnaireResponse
+GET_QUESTIONNAIRE_RESPONSE_DIRECTORY = "./api/examples/GET_QuestionnaireResponse/"
+GET_QUESTIONNAIRE_RESPONSE__SUCCESS = f"{GET_QUESTIONNAIRE_RESPONSE_DIRECTORY}success.yaml"
+
+# GET RelatedPerson
 RELATED_DIRECTORY = "./api/examples/GET_RelatedPerson/"
 RELATED__ERROR_IDENTIFIER_MISSING = f"{RELATED_DIRECTORY}errors/invalid-identifier-missing.yaml"
 RELATED__ERROR_IDENTIFIER_SYSTEM = f"{RELATED_DIRECTORY}errors/invalid-identifier-system.yaml"

sandbox/api/get_consent.py

@@ -20,9 +20,9 @@
     INVALIDATED_RESOURCE,
 )
 from .utils import (
-    check_for_get_consent_errors,
     check_for_consent_filtering,
     check_for_consent_include_params,
+    check_for_get_consent_errors,
     generate_response_from_example,
     remove_system,
 )

sandbox/api/get_questionnaire_response.py

@@ -0,0 +1,21 @@
+from logging import INFO, basicConfig, getLogger
+from typing import Union
+
+from .constants import INTERNAL_SERVER_ERROR_EXAMPLE, GET_QUESTIONNAIRE_RESPONSE__SUCCESS
+from .utils import generate_response_from_example
+
+basicConfig(level=INFO, format="%(asctime)s - %(message)s")
+logger = getLogger(__name__)
+
+
+def get_questionnaire_response_response() -> Union[dict, tuple]:
+    """Sandbox API for GET /QuestionnaireResponse
+
+    Returns:
+        Union[dict, tuple]: Response for GET /QuestionnaireResponse
+    """
+    try:
+        return generate_response_from_example(GET_QUESTIONNAIRE_RESPONSE__SUCCESS, 200)
+    except Exception:
+        logger.exception("GET questionnaire response failed")
+        return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)