GetGeometryClassifications()

The GetGeometryClassifications() command returns a list of geometry types in Field View.

  • Quota: 1
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiToken string20Y Your API security token configured in Field View.
geometryClassificationDescriptionstring100 Filters the returned results where the geometry classification description contains the supplied string.
businessUnitIDsString[]100 Filters the returned results where the geometry classifications is business unit, is in the supplied business unit ids. Otherwise the function will return all geometry classifications in and below the business unit ID the API token was configured against. The business units ids should be contained in GetBusinessUnits().
activeOnlybooleanY If true only active geometry classifications will be returned. If false all geometry classifications will be returned.
Table 2. Returns
FieldTypeDescription
GeometryClassificationInformationGeometryClassificationInformation Geometry classification information structure.
<GeometryClassificationResponse>
       <Status>
           SUCCESS
           <Message>Success.</Message>
       </Status>
       <GeometryClassificationInformation>
           <ID></ID>
           <Description></Description>
           <GeometryTypeID></GeometryTypeID>
           <GeometryType></GeometryType>
           <VisibilityOrganisationID></VisibilityOrganisationID>
           <OrganisationUnitAndBelow></OrganisationUnitAndBelow>
           <VisibilityOrganisation></VisibilityOrganisation>
           <OwnerOrganisationID></OwnerOrganisationID>
           <OwnerOrganisation></OwnerOrganisation>
           <Active></Active>
       </GeometryClassificationInformation>
   </GeometryClassificationResponse>