Update Geofence Set

This API updates an existing geofence set.

PUT /GeofenceSets

Parameters

Required parameters are highlighted in yellow.

Data ElementDescriptionData TypeValue/Example
SetIdThe Id of the geofence set to update
integer
NameThe name of the geofence set
string
TagThe tag can be used to group sets of geofences together
string
ActiveStateIndicates whether or not CoPilot should honor geofences in this set
integer
0 = Off 1 = Warn 2 = Avoid
VisibleWhether or not the geofences contained within this set are visible
boolean
true/false
BorderColorThe RGB color of the geofences’ borders
integer
0 - 16777215
BorderAlphaThe alpha transparency of the geofences’ borders
integer
0 - 255
BorderWidthThe pixel width of the geofences’ borders
integer
0 - 10
FillColorThe RGB fill color of the geofences
integer
0 - 16777215
FillAlphaThe alpha transparency of the geofences’ fill
integer
0 - 255
StartTimeThe date/time when the geofences contained within this set become active. The time should be formatted according to the ISO 8601 Standard (YYYY-MM-DDTHH:MM:SSZ)
date/time
EndTimeThe date/time when the geofences contained within this set will expire. The time should be formatted according to the ISO 8601 Standard (YYYY-MM-DDTHH:MM:SSZ)
date/time

Response

The return from this operation is 1 for success or an error on failure.

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