PUT GeoFence?reference={reference}
Update an existing GeoFence based on Reference.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
reference |
Reference to the Geofence to Update |
string |
Required |
Body Parameters
A GeoFenceRestResult object
GeoFenceRestItemName | Description | Type | Additional information |
---|---|---|---|
Groups |
List of GeofenceGroupId's. |
Collection of integer |
None. |
GeoJson |
Geo Json. GeoJSON is a format for encoding a variety of geographic data structures. http://geojson.org/ |
string |
None. |
Id |
Internal Primary Key. |
integer |
None. |
Reference |
External Code. |
string |
None. |
Latitude |
Latitude coordinate. Obsolete for reading, use GeoJson in stead. Only used for storing/updating circular geofences. |
decimal number |
None. |
Longitude |
Longitude coordinate. Obsolete for reading, use GeoJson in stead. Only used for storing/updating circular geofences. |
decimal number |
None. |
Radius |
Radius indicating size of GeoFence. Distance unit is meters. |
decimal number |
None. |
Name |
Friendly name for the GeoFence. |
string |
None. |
Code |
Code for the GeoFence. |
string |
None. |
Color |
Color for the GeoFence. |
string |
None. |
IsPoP |
Bool indicating whether this geofence is a Point of Presence. |
boolean |
None. |
IsPersonal |
Bool indicating whether this geofence is personal, so set userId. |
boolean |
None. |
Created | date |
None. |
Request Formats
application/json, text/json
{ "Groups": [ 1, 2 ], "GeoJson": "sample string 1", "Id": 2, "Reference": "sample string 3", "Latitude": 1.1, "Longitude": 1.1, "Radius": 1.1, "Name": "sample string 4", "Code": "sample string 5", "Color": "sample string 6", "IsPoP": true, "IsPersonal": true, "Created": "2025-01-05T02:20:03.0573743+01:00" }
application/xml, text/xml
<GeoFenceRestItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api360.Models"> <Code>sample string 5</Code> <Color>sample string 6</Color> <Created>2025-01-05T02:20:03.0573743+01:00</Created> <GeoJson>sample string 1</GeoJson> <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Groups> <Id>2</Id> <IsPersonal>true</IsPersonal> <IsPoP>true</IsPoP> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> <Name>sample string 4</Name> <Radius>1.1</Radius> <Reference>sample string 3</Reference> </GeoFenceRestItem>
application/x-www-form-urlencoded
Response Information
Resource Description
GeoFenceRestItemName | Description | Type | Additional information |
---|---|---|---|
Groups |
List of GeofenceGroupId's. |
Collection of integer |
None. |
GeoJson |
Geo Json. GeoJSON is a format for encoding a variety of geographic data structures. http://geojson.org/ |
string |
None. |
Id |
Internal Primary Key. |
integer |
None. |
Reference |
External Code. |
string |
None. |
Latitude |
Latitude coordinate. Obsolete for reading, use GeoJson in stead. Only used for storing/updating circular geofences. |
decimal number |
None. |
Longitude |
Longitude coordinate. Obsolete for reading, use GeoJson in stead. Only used for storing/updating circular geofences. |
decimal number |
None. |
Radius |
Radius indicating size of GeoFence. Distance unit is meters. |
decimal number |
None. |
Name |
Friendly name for the GeoFence. |
string |
None. |
Code |
Code for the GeoFence. |
string |
None. |
Color |
Color for the GeoFence. |
string |
None. |
IsPoP |
Bool indicating whether this geofence is a Point of Presence. |
boolean |
None. |
IsPersonal |
Bool indicating whether this geofence is personal, so set userId. |
boolean |
None. |
Created | date |
None. |
Response Formats
application/json, text/json
{ "Groups": [ 1, 2 ], "GeoJson": "sample string 1", "Id": 2, "Reference": "sample string 3", "Latitude": 1.1, "Longitude": 1.1, "Radius": 1.1, "Name": "sample string 4", "Code": "sample string 5", "Color": "sample string 6", "IsPoP": true, "IsPersonal": true, "Created": "2025-01-05T02:20:03.0736607+01:00" }
application/xml, text/xml
<GeoFenceRestItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api360.Models"> <Code>sample string 5</Code> <Color>sample string 6</Color> <Created>2025-01-05T02:20:03.0736607+01:00</Created> <GeoJson>sample string 1</GeoJson> <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Groups> <Id>2</Id> <IsPersonal>true</IsPersonal> <IsPoP>true</IsPoP> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> <Name>sample string 4</Name> <Radius>1.1</Radius> <Reference>sample string 3</Reference> </GeoFenceRestItem>