GetGroup()

The GetGroup() command returns a group with its questions and answers, and other information which may be useful.

  • Quota: 10
Note: Each row contained in the form information list is an instance of a form template, that can be a 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
ParameterTypeMax LengthRequiredDescription
apiToken string 20Y Your API security token configured in Field View.
formId string 20Y The unique ID of the form.
groupAlias string 20Y The alias name of the group in the form.
Table 2. Returns
FieldTypeDescription
FormInformation FormInformation Form information structure.
Example Header

   <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>