The
GetForm()
command
returns a form with its questions and answers, and other information which may be useful.
Note: Each row contained in the form information list is an instance of a form
template, that can be a Template, Group, Table Group, Question or
Static Text. Some columns will only contain information for specific
form template types e.g. The answer column will only contain information
if the form template type is a question, and has been answered.
Table 1. Parameters| Parameter | Type | Max Length | Required | Description |
|---|
|
apiToken
|
string
| 20 | Y |
Your API security token configured in Field View.
|
|
formId
|
string
| 20 | Y |
The unique ID of the form.
|
Table 2. Returns| Field | Type | Description |
|---|
|
FormInformation
| FormInformation |
Form information structure.
|
<FormResponse>
<Status>
SUCCESS
<Message>Success.</Message>
</Status>
<FormInformation>
<FormTemplateID></FormTemplateID>
<FormTemplateLinkID></FormTemplateLinkID>
<FormAnswerID></FormAnswerID>
<SortOrder></SortOrder>
<Type></Type>
<QuestionType></QuestionType>
<DataType></DataType>
<Question></Question>
<Alias></Alias>
<Level></Level>
<Answer></Answer>
<AnsweredBy></AnsweredBy>
<AnsweredDateTime></AnsweredDateTime>
<HasActions></HasActions>
<HasImages></HasImages>
<HasComments></HasComments>
<HasDocuments></HasDocuments>
</FormInformation>
</FormResponse>
