GetSimplePredefinedFormAnswerGroups()

The GetSimplePredefinedFormAnswerGroups() command returns a list of simple (not hierarchical) predefined lists which are configured for an organisation.

  • Quota: 2
Note: This only returns flat (not hierarchical) lists.
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiTokenstring20YYour API security token configured in Field View.
organisationIdintYThe organisationId you want to get the answer groups for.
organisationUnitAndBelow boolean N If the list is visible to organisations below in the business unit structure.
Table 2. Returns
FieldTypeDescription
SimplePredefinedAnswerGroupInformationSimplePredefinedAnswerGroupInformationForm information structure.
Example Header 
   <SimplePredefinedAnswerGroupResponse>
       <Status>
           SUCCESS
           <Message>Success.</Message>
       </Status>
       <PredefinedAnswerGroups>
           <SimplePredefinedAnswerGroupInformation>
                <PredefinedAnswerGroupId></PredefinedAnswerGroupId>
                    <Description></Description>
                    <Measurement></Measurement>
                    <ProjectBasedAnswers></ProjectBasedAnswers>
                    <OrganisationId></OrganisationId>
                    <Organisation></Organisation>
                    <AllowOther></AllowOther>
                    <OrganisationUnitAndBelow></OrganisationUnitAndBelow>
                    <VisibilityOrganisationId></VisibilityOrganisationId>
                    <VisibilityOrganisation></VisibilityOrganisation>
                    <Active></Active>
                    <ParentID></ParentID>
           </SimplePredefinedAnswerGroupInformation>
       </PredefinedAnswerGroups>
   </SimplePredefinedAnswerGroupResponse>