| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The id of this GeoSite |
integer32 |
None. |
| UserGroupId |
The id of the UserGroup this site belongs to |
integer32 |
None. |
| SiteType |
The type of Geosite. This enum can be used to determine which location properties make sense to look at. |
GeoSiteTypeEnum |
None. |
| Name |
The name of the site |
string |
None. |
| Latitude |
The latitude of center of the site. |
decimal number |
None. |
| Longitude |
The longitude of center of the site. |
decimal number |
None. |
| Radius |
Radius in meters. Only used for geosites where SiteType = Geoposition For other types of geosite this will be null |
integer32 |
Range: inclusive between 100 and 100000 |
| Street |
If this Geosite is created from a Google Location Lookup, this is the Street returned from Google, otherwise NULL |
string |
None. |
| Sublocality |
If this Geosite is created from a Google Location Lookup, this is the Sublocality returned from Google, otherwise NULL |
string |
None. |
| Locality |
If this Geosite is created from a Google Location Lookup, this is the Locality returned from Google, otherwise NULL |
string |
None. |
| AdminArea1 |
If this Geosite is created from a Google Location Lookup, this is the AdminArea1 returned from Google, otherwise NULL |
string |
None. |
| AdminArea2 |
If this Geosite is created from a Google Location Lookup, this is the AdminArea2 returned from Google, otherwise NULL |
string |
None. |
| AdminArea3 |
If this Geosite is created from a Google Location Lookup, this is the AdminArea3 returned from Google, otherwise NULL |
string |
None. |
| AdminArea4 |
If this Geosite is created from a Google Location Lookup, this is the AdminArea4 returned from Google, otherwise NULL |
string |
None. |
| AdminArea5 |
If this Geosite is created from a Google Location Lookup, this is the AdminArea5 returned from Google, otherwise NULL |
string |
None. |
| CountryCode |
If this Geosite is created from a Google Location Lookup, this is the CountryCode returned from Google, otherwise NULL |
string |
None. |
| PostalCode |
If this Geosite is created from a Google Location Lookup, this is the PostalCode returned from Google, otherwise NULL |
string |
None. |
| ColloquialArea |
If this Geosite is created from a Google Location Lookup, this is the ColloquialArea returned from Google, otherwise NULL |
string |
None. |
| Ward |
If this Geosite is created from a Google Location Lookup, this is the Ward returned from Google, otherwise NULL |
string |
None. |
| Premise |
If this Geosite is created from a Google Location Lookup, this is the Premise returned from Google, otherwise NULL |
string |
None. |
| PlaceId |
If this Geosite is created from a Google Location Lookup, this is the PlaceId returned from Google, otherwise NULL |
string |
None. |
| CreatedDate |
UTC timestamp for the creation of this GeoSite |
date |
None. |
| VisibleChildren |
Indicates if this GeoSite is accessible from child groups and available to devices in child groups |
boolean |
None. |
| RegisterUnitsOnMove |
Indicates if devices are automatically registered for this geosite when they gain access to it (on device or group move) |
boolean |
None. |
| RegisterUnitsForAlarmsOnMove |
Indicates if all devices that are automatically registered for this geosite will also be registered for alarms based on this geosite when they gain access to it (on device or group move). |
boolean |
None. |
| CanEdit |
Indicates if you have permission to Edit site details. Even if you do not have Edit Permissions, you can still register and deregister devices at the site, if the devices has access to this site |
boolean |
None. |
| RegisteredUnitsCount |
How many devices are currently registered for this site |
integer32 |
None. |
| RegisteredUnitsAtSiteCount |
How many of the registered devices are currently at this site |
integer32 |
None. |
| RegisteredUnitsNotAtSiteCount |
How many of the registered devices are not currently at this site |
integer32 |
None. |
| RegisteredUnits |
The list of devices that are currently registered to this site |
Collection of UnitSiteRegistrationModel |
None. |
| RegisteredUnitsAtSite |
The list of registered devices that are currently at this site |
Collection of UnitAtGeoSiteModel |
None. |
| RegisteredUnitsNotAtSite |
The list of registered devices that are currently not at this site |
Collection of string |
None. |