GetGeometryIDbyPath()

The GetGeometryIDbyPath() command returns the geometry ID for the given geometry path in Field View.

  • Quota: 1
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiTokenstring20Y Your API security token configured in Field View.
projectIDintegerYThe project ID for which to retrieve information.
pathTiersString[]Y The path of the geometry, supplied as individual tiers in order, as a String[].
projectNameIncludedbooleanY Set to true if the first tier, in path tiers, is the project name. Otherwise, if the path tiers does not contain the project name, set to false.
Table 2. Returns
FieldTypeDescription
IDintegerThe ID of the geometry. (The function may return -1 to indicate Inactive or -2 to indicate Deleted.)
Example Header 
<StatusRequest>
       <Status>
           SUCCESS
           <Message>Success.</Message>
       </Status>
       <ID></ID>
   </StatusRequest>