GetGeometryByDescription()

Returns the Assets and Locations in a project that contain your chosen search string.

  • Quota: 1
Table 1. Parameters
Parameter Type Max Length Required Description
apiToken string 20 Y Your API security token configured in Field View.
projectId integer Y The ID of the project you are searching.
description string 100 N The description of the geometry.
parentId int N The parent ID of the geometries you are searching.
isExactMatch bool N Geometry with an exact match with the description.
Table 2. Returns
Field Type Description
GeometryInformation GeometryInformation Geometry information structure.
Example Header 
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ns="https://localhost.priority1.uk.net/Priority1WebServices/XML">
   <soap:Header/>
   <soap:Body>
      <ns:GetGeometryByDescription>
         <ns:apiToken>?</ns:apiToken>
         <ns:projectId>?</ns:projectId>
         <ns:description>?</ns:description>
         <ns:parentId>?</ns:parentId>
         <ns:isExactMatch>?</ns:isExactMatch>
      </ns:GetGeometryByDescription>
   </soap:Body>
</soap:Envelope>
Example Results
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetGeometryByDescriptionResponse xmlns="https://localhost.priority1.uk.net/Priority1WebServices/XML">
         <GetGeometryByDescriptionResult>
            <ElementResponse xmlns="">
               <Status>
                  <Code>SUCCESS</Code>
                  <Message>Success. [ActivityId]: 531e2ab5-cd14-4c6d-bbb0-3ecbc5c4b4ea</Message>
               </Status>
  <ElementInformation>
                  <GeometryInformation>
                     <ID>5</ID>
                     <ProjectID>3</ProjectID>
                     <ParentID>3</ParentID>
                     <Description>Floor 0</Description>
                     <ResponsibleOrganisationID xsi:nil="true"/>
                     <GeometryTypeID>1</GeometryTypeID>
                     <GeometryType>Location</GeometryType>
                     <GeometryClassificationID>11</GeometryClassificationID>
                     <GeometryClassification>Apartment</GeometryClassification>
                     <GeometryImageID xsi:nil="true"/>
                     <Quantity>1</Quantity>
                     <Active>true</Active>
                     <Deleted>false</Deleted>
                  </GeometryInformation>
               </ElementInformation>
            </ElementResponse>
         </GetGeometryByDescriptionResult>
      </GetGeometryByDescriptionResponse>
   </soap:Body>
</soap:Envelope>