Get Geofence Set

The /GeofenceSets GET request 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.

GET

URL Parameters

Required parameters are highlighted in yellow.

Response

Loading...
      
    

Geofence Set Response

Data ElementDescriptionData TypeValue/Example
ActiveStateIndicates whether or not CoPilot should honor geofences in this setinteger
BorderAlphaThe alpha transparency of the geofences’ bordersinteger
BorderColorThe color of the geofences’ bordersinteger
BorderWidthThe pixel width of the geofences’ bordersinteger
EndTimeThe date/time when the geofences contained within this set will expiredate/time
FillAlphaThe alpha transparency of the geofences’ fillinteger
FillColorThe fill color of the geofencesinteger
NameThe name of the geofence setstring
StartTimeThe date/time when the geofences contained within this set become activedate/time
TagThe tag can be used to group sets of geofences togetherstring
VisibleWhether or not the geofences contained within this set are visiblebooleantrue/false
DeletedWhether or not this geofence set has been deletedbooleantrue/false
FencesThe geofences contained within this setComplex
IdThe Id of this geofence setinteger

Geofence

Data ElementDescriptionData TypeValue/Example
EndTimeThe date/time when the geofences contained within this set will expiredate/time
NameThe name of the geofencestring
RadiusFor circular geofences, the radius in miles the geofence extends from a center pointdecimal
LabelThe optional label of the geofence. Max length is 255.string
SetIdThe Id of the set that contains this fenceinteger
CountyThe county or jurisdictionstring
ShapePointsAn array containing the latitude/longitude pairs that define this fencearray of decimals[ [-74.12883,40.700414],
[-74.029609,40.703538],
[-74.059135,40.779233],
[-74.12883,40.700414] ]
ShapeTypeThe type of the geofence shape.integer1 = circle
5 = polygon
StartTimeThe date/time when the geofences contained within this set become activedate/time
IdThe Id of this geofenceinteger

Errors

Data ElementDescriptionData TypeValue/Example
TypeIndicates whether the error is an exception or warningEnumWarning
Exception
CodeError codeEnumPlease 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