Get Geofence Set

You can retrieve all of your geofence sets at once or by a limited number of search parameters. The response will include data about the set. If includeFences is true, it will contain all the fences contained within.

Request

GET

URL Parameters

Required parameters are highlighted in yellow.

Response

Loading...
                    
                    

Geofence Set Response

Data Element Description Data Type Value/Example Note
ActiveState Indicates whether or not CoPilot should honor geofences in this set integer
BorderAlpha The alpha transparency of the geofences' borders integer
BorderColor The color of the geofences' borders integer
BorderWidth The pixel width of the geofences' borders integer
EndTime The date/time when the geofences contained within this set will expire date/time
FillAlpha The alpha transparency of the geofences' fill integer
FillColor The fill color of the geofences integer
Name The name of the geofence set string
StartTime The date/time when the geofences contained within this set become active date/time
Tag The tag can be used to group sets of geofences together string
Visible Whether or not the geofences contained within this set are visible boolean true/false
Deleted Whether or not this geofence set has been deleted boolean true/false
Fences The geofences contained within this set complex
Id The Id of this geofence set integer

Geofence

Data Element Description Data Type Value/Example Note
EndTime The date/time when the geofences contained within this set will expire date/time
Name The name of the geofence string
Radius For circular geofences, the radius in miles the geofence extends from a center point decimal
Label The optional label of the geofence. Max length is 255. string
SetId The Id of the set that contains this fence integer
County The county or jurisdiction string
ShapePoints An array containing the latitude/longitude pairs that define this fence array of decimals [ [-74.12883,40.700414], [-74.029609,40.703538], [-74.059135,40.779233], [-74.12883,40.700414] ]
ShapeType The type of the geofence shape. integer 1 = circle
5 = polygon
StartTime The date/time when the geofences contained within this set become active date/time
Id The Id of this geofence integer

Errors

Data Element Description Data Type Value/Example Note
Type Indicates whether the error is an exception or warning Enum Warning
Exception
Code Error code Enum Please refer to Appendix for complete list
LegacyErrorCode The legacy error code with is an integer valued code that would have been returned in PCMiler Web Services v25 and earlier. int
Description The detailed error description. String