Update Geofence Set

The /GeofenceSets PUT request updates an existing geofence set.

Request

PUT https://pcmiler.alk.com/apis/rest/v1.0/Service.svc/GeofenceSets

URL Parameters

Required parameters are highlighted in yellow.

Data ElementDescriptionData TypeValue/Example
SetIdThe Id of the geofence set to updateinteger
NameThe name of the geofence setstring
TagThe tag can be used to group sets of geofences togetherstring
ActiveStateIndicates whether or not CoPilot should honor geofences in this setinteger0 = Off 1 = Warn 2 = Avoid
VisibleWhether or not the geofences contained within this set are visiblebooleantrue/false
BorderColorThe RGB color of the geofences’ bordersinteger0 - 16777215
BorderAlphaThe alpha transparency of the geofences’ bordersinteger0 - 255
BorderWidthThe pixel width of the geofences’ bordersinteger0 - 10
FillColorThe RGB fill color of the geofencesinteger0 - 16777215
FillAlphaThe alpha transparency of the geofences’ fillinteger0 - 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 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