Get Geofence Set

Table of Contents

This API retrieves geofence sets. You can retrieve all of your geofence sets at once or individual sets using the request parameters. If includeFences is set to true, it will contain all of the fences contained within a set.

Geofence Set Response

Data ElementDescriptionData TypeValue/Example
ActiveStateIndicates whether or not CoPilot should honor geofences in this set
integer
BorderAlphaThe alpha transparency of the geofences’ borders
integer
BorderColorThe color of the geofences’ borders
integer
BorderWidthThe pixel width of the geofences’ borders
integer
EndTimeThe date/time when the geofences contained within this set will expire
date/time
FillAlphaThe alpha transparency of the geofences’ fill
integer
FillColorThe fill color of the geofences
integer
NameThe name of the geofence set
string
StartTimeThe date/time when the geofences contained within this set become active
date/time
TagThe tag can be used to group sets of geofences together
string
VisibleWhether or not the geofences contained within this set are visible
boolean
true/false
DeletedWhether or not this geofence set has been deleted
boolean
true/false
FencesThe geofences contained within this set
Complex
IdThe Id of this geofence set
integer

Geofence

Data ElementDescriptionData TypeValue/Example
EndTimeThe date/time when the geofences contained within this set will expire
date/time
NameThe name of the geofence
string
RadiusFor circular geofences, the radius in miles the geofence extends from a center point
decimal
LabelThe optional label of the geofence. Max length is 255.
string
SetIdThe Id of the set that contains this fence
integer
CountyThe county or jurisdiction
string
ShapePointsAn 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] ]
ShapeTypeThe type of the geofence shape.
integer
1 = circle
5 = polygon
StartTimeThe date/time when the geofences contained within this set become active
date/time
IdThe Id of this geofence
integer

Errors

Data ElementDescriptionData TypeValue/Example
TypeIndicates whether the error is an exception or warning
Enum
Warning
Exception
CodeError code
Enum
Please refer to Appendix for complete list
LegacyErrorCodeThe legacy error code with is an integer valued code that would have been returned in PC*MILER Web Services v25 and earlier.
Int
DescriptionThe detailed error description.
string
Last updated May 6, 2020.