> For the complete documentation index, see [llms.txt](https://docs.vomevolunteer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vomevolunteer.com/resources/editor-3/the-form-submission-object.md).
# The Form Submission object
{% code overflow="wrap" %}
```json
{
"id": "60c5e52b-e680-4b62-adc1-207e4ced130f",
"user": {
"id": "443f05ad-b1be-43bc-a213-3483471bc7fa",
"first_name": "Lara",
"last_name": "Smith",
"email": "lara_smith@domain.com",
"gender": 0,
"address": "2934 Thurlow Road, Hampstead, Montreal, QC, Canada",
"phone_number": "929384838",
"date_of_birth": "1973-03-04",
"timezone": "America/Toronto",
"address_coordinates": [
"45.4787326",
"-73.6406602"
]
},
"submission_status": "New",
"created_at": "2024-10-30T21:19:53.069586Z",
"sites": [
{
"id": "f3277763-8f13-43a1-9276-358d810d2a9b",
"title": "Site A"
}
],
"categories": [
{
"id": "65e619c4-94a8-4259-877d-ecc0ca3c0822",
"title": "Events & Prizes"
},
]
},
"arrival_source": {
"id": "182e2f04-0d3c-4637-89a7-c6dbae95e90f",
"category": {
"id": "c82cd6c8-0b5a-48af-853d-0a57e6954969",
"title": "Title of Category A",
"description": "Description of Category A"
},
"title": "Opportunity Title A",
"description": "Description of Title A"
},
"questions": [
{
"id": "6d51d684-70a0-4d3e-a5ef-db61025e03de",
"question": {
"id": "d56d80ac-7665-49bd-b7f1-ddd6873377bd",
"title": "If applicable, describe your previously involvement here.",
"question_type": 0,
"options": []
},
"answer": "",
"options": [],
"responded": false
},
{
"id": "24fec7ab-b5a6-4803-9f92-73e2aa9983d3",
"question": {
"id": "c9cf2681-17e0-4924-a1ae-97af4315d335",
"title": "Decide the necessary percentages here?",
"question_type": 10,
"options": [
"Trees",
"Forest",
"Water"
],
"allocation_input_type": 1,
"allocation_total": "100.0000",
"allocation_decimal_places": 2
},
"answer": "",
"options": [],
"date": null,
"responded": true,
"allocation_values": {
"Trees": "10.00",
"Forest": "70.00",
"Water": "20.00"
},
"auto_populated_lists": []
},
{
"id": "70893686-0feb-421a-9808-212191799ed8",
"question": {
"id": "8edd39f0-a30d-4952-90ff-1b8cd1fff550",
"title": "What opportunities are you interested in?",
"question_type": 11,
"options": []
},
"answer": "",
"options": [],
"date": null,
"responded": true,
"allocation_values": null,
"auto_populated_lists": [
{
"id": "a79d14ff-6611-4229-b244-f8151efd275f",
"title": "12-h volunteers"
},
{
"id": "53fb7d1c-11c0-41af-bad0-be0962588cf8",
"title": "Administrator"
}
]
},
{
"id": "24666398-306d-4058-a058-50364af12c06",
"question": {
"id": "3a25e1ab-fb49-49d1-ab6a-690e03e5a5cd",
"title": "Which days of the week would you like to join us?",
"question_type": "Checkbox",
"options": [
"Thursday",
"Tuesday/Thurs",
"Friday"
]
},
"answer": "",
"options": [
"Friday"
],
"responded": true
}
],
"medical_info": null,
"emergency_contact": {
"name": "Daniel",
"relationship": "Dad",
"phone_number": "9389393898"
},
"digital_consent": [
{
"id": "dc6a12a3-10da-49b7-bdf9-51514439f063",
"digital_consent_info": null,
"consent_status": 3 //Not provided
}
],
"general_availability": [
{
"id": "7b8cca42-fcfd-4566-9715-7a9ec57132bf",
"day": 2, //Tuesday
"availability": "Morning"
}
],
"attachments": [
{
"id": "6c93e611-7e06-4aeb-9e30-fdad10126c2b",
"document_file": null,
"notes": "",
"attachment_info": {
"id": "854c5709-af07-49bd-b653-6a17154d192e",
"title": "Drivers License",
"description": ""
}
}
],
"opportunities": [
{
"opportunity": {
"id": "6dd9de34-eee5-48dc-a684-edef63f7cd61",
"category": {
"id": "c82cd6c8-0b5a-48af-853d-0a57e6954969",
"title": "Category Title A",
"description": "Description of Category Title A"
},
"title": "Opportunity Title A",
"description": "Description of Opportunity Title A"
},
"opportunity_shifts_count": 1
},
],
"folder": {
"name": "Basketball Program"
},
"form": {
"id": "b4078162-9d3c-41fa-abbb-aada180c87d5",
"title": "Form Title A"
}
}
```
{% endcode %}
#### **Components of the Submission Detail Objects**
Each submission detail object provides comprehensive data related to a specific form submission by a user, which includes:
* **id (**`string`**)**: A unique identifier for the form submission.
* [**user** ](#user-object)**(**`User` `Object`**)**: Details of the user who made the submission.
* **submission\_status (**`string`**)**: Status of the submission (e.g., New, Reviewed), including:
* **New**: Initial status for a form submission.
* **In Review**: Submission is currently being reviewed.
* **Reviewed**: Submission has been reviewed.
* **Rejected**: Submission has been rejected.
* **Completed**: Submission process is completed.
* **created\_at (**`string`**)**: Timestamp indicating when the form was submitted.
* [**arrival\_source** ](#arrival-source-array)(`Arrival Source Array`)
* [**questions**](#questions-array) **(**`Questions Array)`: A collection of questions and responses included in the submission.
* [**medical\_info**](#medical-information-object) **(**`Medical Information Object)`: Basic medical information provided in the submission added by the user.
* [**emergency\_contact**](#emergency-contact-object) **(**`Emergency Contact Object`**)**: Emergency contact details provided by the user.
* [**digital\_consent** ](#digital-consent-array)**(**`Consent Array`**)**: Tracks digital consent provided by the user.
* [**general\_availability**](#availability-array) **(**`Availability Array`**)**: General availability time slots, including days of the week coupled with the time of day (i.e. morning, afternoon, evening or a custom time slot provided by the user).
* [**attachments**](#attachments-array) **(**`Attachments Array`**)**: Any files or documents attached to the submission as part of an attachments field.
* [**opportunity**](#opportunity-array) **(**`Opportunity Array`**)**: Opportunities relating to shifts that were associated with the submission, if any.
* [**folder** ](#folder-object)**(**`Form Object`**)**: The folder related to the form which was submitted by the user.
* [**form**](#form-object) **(**`Form Object`**)**: Information about the form that was submitted, including the ID and title.
* [**auto\_populated\_lists**](#auto-populated-lists-object-auto_populated_lists) (Auto-Populated Lists Object): Server-provided option lists used to render Powered Select UI (opportunities, sites, and categories).
* **allocation\_values** is the parsed JSON map of answers for allocation questions (question\_type = 10).
* Key: each allocation option label (from question.options)
* Value: the entered amount as a string (for example ["25.00"](app://-/index.html#))
\
**Detailed Component Structures**
#### **User Object**
Comprehensive details about the user's profile information.
* **id (**`string`**)**: Unique identifier for the user.
* **first\_name**, **last\_name**, **full\_name** (`string`): The name of the user.
* **email** (`string`): Email address of the user.
* **gender** (`string` | `null`): The gender of the user. \
\
`0` = Male\
`1` = Female\
`2` = Other\
`3` = User inputted they would rather not say
* **address** (`string`): The complete address of the user.
* **phone\_number** (`string`): Phone number of the user.
* **date\_of\_birth** (`string` | `null`): The date of birth of the user.
* **address\_coordinates** (`array`): Geographic coordinates of the user if an address was address via Google Maps. If the address was added via the import process, this data would not be available.
#### **Arrival Source Array**
In some circumstances, a user may be redirected to submit a form when trying to apply for an opportunity. When this occurs, we indicate the opportunity for which the user arrived from.
* **id (string)**: Identifier of the opportunity for which the user arrived from when submitting this form.
* **title** (`string`): Title of the opportunity.
* **description** (`string`): description of the opportunity.
* **category** (**category Object**): Includes the categories related to the opportunity
* **id** (`string`): Identifier of the category.
* **title** (`string`): Title of the category.
#### **Questions Array**
Each entry in this array represents a question and its respective answer:
* **id (**`string`**)**: Identifier for the question within the form.
* [**question** ](#question-object)**(**`Question Object`**)**: Details of the question, including the title, type and options available.
* **answer (**string**)**: The answer provided by the user (if the question type is not a single or multiple selection).
* **options (**`array`**)**: The answer provided by the user (if the question type is a *single or multiple selection field).*
* **responded (**`boolean`**)**: Indicates whether the question was answered by the user.
#### **Question Object**
* **id (**`sting`**):** Identifier for the question, which can be used across multiple forms.
* **title (**`string`**)**: The text of the question.
* **type (**`integer`**)**: Represents the type of question, including:
* `0`: Text
* `1`: Single Selection
* `2`: Multiple Selection
* `3`: Date
* `4`: Timeslot
* `5`: Address
* `6`: Number
* `7`: Email
* `8`: Website
* `9`: Boolean
* 10: Allocation
* 11: Powered Select
* **options (**`array`**)**: Any selectable options associated with the question. *Only applicable for single or multiple selection fields.*
* **`allocation_input_type`** (integer): controls the unit expected for each value in allocation\_values all supported types include:
* 0 : Percent
* 1 : Number
* **`allocation_total`** (string decimal): The required sum of all allocation entries for the question (for example, `"100.0000"`).
* **`allocation_decimal_places`** (integer): Maximum number of decimal places allowed per allocation entry (for example, `2` allows `10.25` but not `10.257`)
***
#### **Medical Information Object**
* **description (**`string`**)**: Description of any medical information provided by the user.
* **has\_medical\_info (**`boolean`**)**: Indicates whether there is any medical information inputted for this user.
#### **Emergency Contact Object**
* **name (**`string`**)**: The name of the emergency contact.
* **phone\_number (**`string`**)**: The phone number of the emergency contact.
* **relationship (**`string`**)**: The relationship of the contact to the user.
#### **Digital Consent Array**
This array contains details about the digital consent provided by the user:
* **id (**`string`**)**: Unique identifier for the consent entry.
* **digital\_consent\_info (`integer`)**: Includes the information created by the organization regarding the type of consent requested.
* **consent\_status (`integer`)**: Indicates whether consent was provided or not.
* `0`: Typed
* `1`: Uploaded
* `2`: Not responded
#### **Emergency Contact Object**
* **name (**`string`**)**: The name of the emergency contact.
* **phone\_number (**`string`**)**: The phone number of the emergency contact.
* **relationship (**`string`**)**: The relationship of the contact to the user.
#### **Availability Array**
Outlines the general availability inputted by the user on this form:
* **id (**`string`**)**: Identifier for the availability entry of the user's form.
* **day (**`integer`**)**: Day of the week represented numerically.
* `0`: Sunday
* `1`: Monday
* `2`: Tuesday
* `3`: Wednesday
* `4`: Thursday
* `5`: Friday
* `6`: Saturday
* **availability (**`string`**)**: Description of the availability (e.g., Morning, Afternoon, Evening or Custom time slot).
#### **Attachments Array**
Details of documents attached to the form by the user:
* **id (**`string`**)**: Unique identifier for the attachment on the form.
* **document\_file (**`string`**)**: URL of the attached document by the user
* **attachment\_info (**`Object`**)**: Details about the attachment requested by the admin including the ID, title and description shown to users.
* **id (**`string`**)**: Unique identifier for the attachment, which can be used across many forms.
* **title (**`string`**)**: title of the attachment field added by the organization.
* **description (**`Object`**)**: description of the attachment field added by the organization.
#### **Opportunity Array**
If a user submits the form and includes shifts on it, we provide a list of the opportunities related to the the shift along with the count of the number of shifts submitted for it.
* **id** (`string`): Identifier of the opportunity.
* **title** (`string`): Title of the opportunity.
* **description** (`string`): Description of the opportunity.
* **opportunity\_shifts\_count** (`string`): Number of requested shifts included on the form submission for that opportunity.
* **category** (**Category Object**): Details of the related category to this opportunity
* **id** (`string`): Identifier of the category.
* **title** (`string`): Title of the category.
* **description** (`string`): Description of the category.
#### Folder Object
* **name** (`string`): Name of folder related to the form which was submitted by the user
#### **Form** Object
Details of the form submitted:
* **id (string)**: Unique identifier for the form which was submitted .
* **title (string)**: The title of the form which was submitted
#### **Auto-Populated Lists Object (auto\_populated\_lists)**
* categories (array of {id, title}): List of available Opportunities (categories).
* sites (array of {id, title}): List of available Organization Sites.
* opportunities (array of {id, title}): List of available Opportunity Roles (position titles).