Overview
The Forms Object contains information about the Forms that are being submitted with the order
Form Object
This lives under orderForms on the Event Template Object that the Form is attached to.
| Field Name | Description |
|---|---|
| id | The ID of the form that is attached to the Event |
| name | The form name |
| source | The source of the form response. Always 'acme'. |
| sourceFormDefinition | A list of all the form fields. |
| state | 'published' or 'draft' |
| lastUpdatedDate | The date the form was last updated. |
| lastPublishedDate | The date the form was last published. |
| preferences.pos | 'displayed' or 'required' |
| preferences.b2c | 'displayed' or 'none' |
| oncePerCart | 'true' or 'false' If there is more than 1 event in the cart with the same form and: 1. This is set to 'true', then the customer will only be asked to fill the form once. 2. This is set to 'false', then the customer will be asked to fill out the form once per Event in their cart that the form is tied to |
Form Response Object
| Field Name | Description |
|---|---|
| id | The Form Response ID: the unique ID of the response that is submitted on the order |
| formId | The ID of the form that is attached to the Event |
| name | The form name |
| type | The type of form. Always 'order'. |
| source | The source of the form response. Always 'acme'. |
| customFields | An array that holds any custom fields on the form |
| responseData | An array with one object per field |
| responseData.fields.value | The value the user submitted for the field |
| responseData.fields.label | The label for the form field |
| responseData.fields.name | The database name for the field |
| publishedFormTemplate.id | The ID of the form that is attached to the Event. This equals 'formId'. |
| publishedFormTemplate.name | The form name. This equals 'name' above. |
| publishedFormTemplate.type | This equals 'type' above. |
| publishedFormTemplate.source | This equals 'source' above. |
| publishedFormTemplate.sourceFormDefinition | A list of all the form fields. |
| publishedFormTemplate.state | 'published' or 'draft' |
| publishedFormTemplate.lastUpdatedDate | The date the form was last updated. |
| publishedFormTemplate.lastPublishedDate | The date the form was last published. |
| publishedFormTemplate.oncePerCart | 'true' or 'false' If there is more than 1 event in the cart with the same form and: 1. This is set to 'true', then the customer will only be asked to fill the form once. 2. This is set to 'false', then the customer will be asked to fill out the form once per Event in their cart that the form is tied to |