The GetGeometryIDbyPath() command returns the geometry ID for the given geometry path in Field View.
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 project ID for which to retrieve information. |
|
pathTiers | String[] | | Y |
The path of the geometry, supplied as individual tiers in order, as a String[]. |
|
projectNameIncluded | boolean | | Y |
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| Field | Type | Description |
|---|
| ID | integer | The 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>
