Skip to main content

Get Geofence

Please see the Sites feature in our Places API if you are looking for predefined geofences around warehouses, distribution centers, and many other important trucking facilities in North America.

This API retrieves geofences by name or ID.

GET /Geofence

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
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 December 6, 2022.