GetFormTemplateDetails()
Provides all the information for a form template including child questions, groups, and table groups.
|
Parameter | Type | Max Length | Required | Description |
---|---|---|---|---|
apiToken | string | 20 | Y | Your API security token configured in Field View. |
formTemplateId | string | 20 | Y | The unique ID of the form template. |
Field | Type | Description |
---|---|---|
FormTemplateId | integer | the ID of the form template question |
ParentId | integer | the ID of the parent |
ShortQuestion | string | These have different meanings based on the node type. See below for details. |
LongQuestion | string | |
SortOrder | integer | the order of the question within the form template |
Level | integer | the question's level within the template heirarchy |
NodeType | ListOfFormTemplateNodeTypes | the type of node; options are Question, Group, Hyperlink, or Static Text |
QuestionType | ListOfQuestionTypes | the type of question |
Note:
These pertain to the API generally:
These pertain to the ShortQuestion and
LongQuestion:
|
<FormTemplateDetailsResponse>
<Status>
SUCCESS
<Message>Success.</Message>
</Status>
<FormTemplateDetailsInformation>
<FormTemplateId></FormTemplateId>
<ParentId></ParentId>
<ShortQuestion></ShortQuestion>
<LongQuestion></LongQuestion>
<SortOrder></SortOrder>
<Level></Level>
<NodeType></NodeType>
<QuestionType></QuestionType>
</FormTemplateDetailsInformation>
</FormTemplateDetailsResponse>