POST api/GeoSites/CreateFromLatLong
Creates a geosite from latitude, longitude and radius information.
Request Information
URI Parameters
None.
Body Parameters
CreateLatLongGeoSiteRequestName | Description | Type | Additional information |
---|---|---|---|
Name |
the name of the site |
string |
Required Min length: 3 |
Latitude |
The latitude of center of the site. |
decimal number |
Required Range: inclusive between -90 and 90 |
Longitude |
The longitude of center of the site. |
decimal number |
Required Range: inclusive between -180 and 180 |
Radius |
Radius in meters. Note: GeoSites that are very small (<200m) can cause problems with triangulating units. Note: GeoSites that are overly large (>20000m) can overlap other geosites and cause informational confusion. |
integer32 |
Required Range: inclusive between 100 and 100000 |
UserGroupId |
The id if the UserGroup the GeoSite should be created in |
integer32 |
Required Range: inclusive between 0 and 2147483647 |
VisibleChildren |
Indicates if this GeoSite is accessible from child groups and available to units in child groups |
boolean |
Required |
RegisterUnitsOnMove |
Indicates if devices are automatically registered for this geosite when they gain access to it (on device or group move) (optional, default is false). |
boolean |
None. |
RegisterUnitsForAlarmsOnMove |
Indicates if all devices that are automatically registered for this geosite should also be registered for alarms based on this geosite when they gain access to it (on device or group move) (optional, default is false). If RegisterUnitsOnMove is false, this must also be set false. |
boolean |
None. |
RegisterUnits |
Indicates if all devices that will have access to the new GeoSite should be registered to this site upon creation |
boolean |
Required |
RegisterForAlarms |
Indicates if all devices that will have access to the new GeoSite should be registered for alarms based on this geosite upon creation If RegisterUnits is false, this must also be set false. |
boolean |
Required |
Request Formats
application/json, text/json
{ "Name": "sample string 1", "Latitude": 2.1, "Longitude": 3.1, "Radius": 4, "UserGroupId": 5, "VisibleChildren": true, "RegisterUnitsOnMove": true, "RegisterUnitsForAlarmsOnMove": true, "RegisterUnits": true, "RegisterForAlarms": true }
application/xml, text/xml
<CreateLatLongGeoSiteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.GeoSites"> <RegisterForAlarms>true</RegisterForAlarms> <RegisterUnits>true</RegisterUnits> <RegisterUnitsForAlarmsOnMove>true</RegisterUnitsForAlarmsOnMove> <RegisterUnitsOnMove>true</RegisterUnitsOnMove> <UserGroupId>5</UserGroupId> <VisibleChildren>true</VisibleChildren> <Latitude>2.1</Latitude> <Longitude>3.1</Longitude> <Name>sample string 1</Name> <Radius>4</Radius> </CreateLatLongGeoSiteRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Creates a geosite from latitude, longitude and radius information.
CreatedNegotiatedContentResultOfGeoSiteInfoModelName | Description | Type | Additional information |
---|---|---|---|
Location | URI |
None. |
|
Content | GeoSiteInfoModel |
None. |
|
ContentNegotiator | IContentNegotiator |
None. |
|
Request | HttpRequestMessage |
None. |
|
Formatters | Collection of MediaTypeFormatter |
None. |
Response Formats
application/json, text/json
Sample not available.