Retrieve a form submission

This endpoint provides a way to retrieve a specific form submission using the form submission ID.

Endpoint Description:

  • Endpoint: GET /api/form-submissions/{submission_id}/

  • Base URL: https://api.vomevolunteer.com

Path Parameter:

  • submission_id (string): The unique identifier for the form submission to be retrieved.

Example Request:

GET https://api.vomevolunteer.com/api/form-submissions/6e84d2e9-ceb2-4b58-9bfb-97f49dd267e7/

Authorization:

Requests must include an API key in the header for authentication.

headers = {
    "API-KEY": "your_unique_api_key_here"
}
response = requests.get("https://api.vomevolunteer.com/api/form-submissions/6e84d2e9-ceb2-4b58-9bfb-97f49dd267e7", headers=headers)
{
    "id": "71cb5387-05f4-49f2-b998-6cfa4dd3fd65",
    "user": {
        "id": "403739ed-fa46-4c16-98bf-b56c5b9ec591",
        "first_name": "Rondo",
        "last_name": "Smith",
        "email": "[email protected]",
        "gender": null,
        "address": "",
        "phone_number": "2938938983",
        "date_of_birth": "2004-05-07",
        "timezone": "America/Toronto",
        "address_coordinates": null
    },
    "submission_status": "New",
    "created_at": "2024-04-16T19:25:25.191541Z",
    "arrival_source": null,
    "questions": [
        {
            "id": "7c67dd8c-5bdc-4cd9-b69f-539bac06ea84",
            "question": {
                "id": "ebed26be-d273-4436-950c-43c324f28349",
                "title": "Have you volunteered here before?",
                "question_type": "Text",
                "options": []
            },
            "answer": "No",
            "options": [],
            "responded": true
        },
        {
            "id": "b30dbc98-59aa-4459-a256-9d741acea9d0",
            "question": {
                "id": "cdbe04f8-769f-4211-b26f-f415faa075ce",
                "title": "What is your meal preference?",
                "question_type": "MCQ",
                "options": [
                    "Veggie",
                    "Beef",
                    "Chicken"
                ]
            },
            "answer": "",
            "options": [
                "Chicken"
            ],
            "responded": true
        },
        {
            "id": "a5ff827b-1f74-4e81-9e9a-dd7582cafa4d",
            "question": {
                "id": "3a25e1ab-fb49-49d1-ab6a-690e03e5a5cd",
                "title": "What type of shifts would you like to do?",
                "question_type": "Checkbox",
                "options": [
                    "Thursday",
                    "Tuesday/Thurs",
                    "Friday"
                ]
            },
            "answer": "",
            "options": [
                "Tuesday/Thurs"
            ],
            "responded": true
        },
        {
            "id": "5c514c09-b9c2-42a9-b091-b08dc924847e",
            "question": {
                "id": "2590a734-3134-4b9c-be19-23c97f13ea36",
                "title": "When do your drivers license expire?",
                "question_type": "Date",
                "options": []
            },
            "answer": "",
            "options": [],
            "responded": true
        },
        {
            "id": "96f302c7-4740-4c6b-9941-28d71d36f01c",
            "question": {
                "id": "93b8dff2-6e24-4afb-991f-70b9c563c2f2",
                "title": "Do you wish to continue after the commitment has passed?",
                "question_type": "Text",
                "options": []
            },
            "answer": "Sample",
            "options": [],
            "responded": true
        }
    ],
    "medical_info": null,
    "emergency_contact": {
        "id": "f1eb88f8-1296-4ed5-b2e0-e547462fa41e",
        "name": "Sarah",
        "relationship": "Mom",
        "phone_number": "9389839839"
    },
    "digital_consent": [
        {
            "id": "648f12af-65a5-4fee-8024-b8aa855fb30a",
            "digital_consent_info": null,
            "attached_file": "http://3.96.242.26:8030/files/opportunity/volunteer/consentforms/08ebb26d-8776-46e8-8807-1a1e6d506c3b.jpg",
            "consent_status": 0 //signed
        }
    ],
    "general_availability": [
        {
            "id": "c4e102f6-82b4-41a5-8e21-88c37bfe8335",
            "day": 5, //Friday
            "availability": "All-day"
        }
    ],
    "attachments": [
        {
            "id": "938e17e6-2f54-48c5-97b8-5b3122a50c68",
            "document_file": "http://3.96.242.26:8030/files/opportunity/volunteer/documents/d0fd5ec9-e483-47ce-a114-89a193fb52c5.png",
            "notes": "",
            "attachment_info": {
                "id": "df8e16e0-da04-47e8-841b-f8ebebfd24ca",
                "title": "Resume",
                "description": "<p>Description sample 43</p>"
            }
        },
        {
            "id": "eaab1a2c-d9f5-493a-b2e3-eeda0b3585e9",
            "document_file": "http://3.96.242.26:8030/files/opportunity/volunteer/documents/698bac47-2501-4824-afcd-8138a9a4be0e.png",
            "notes": "",
            "attachment_info": {
                "id": "165c91c2-10ed-4c2c-b5f5-20a3611cbd31",
                "title": "Cover Letter",
                "description": "Please provide a 1 page CL"
            }
        }
    ],
    "opportunities": [],
    "folder": {
        "name": ""
    },
    "form": {
        "id": "c3f4a2e6-bffa-47a5-87ab-653dcbd6718b",
        "title": "Test Template #2"
    }
}

Last updated