GeoFenceConfigurationResponse
Response for /api/v1/application/configurations/geofence endpoint. It provides a response if the configuration was created and saved in the system.
GeoFenceConfigurationResponse
Response for /api/v1/application/configurations/geofence endpoint. It provides a response if the configuration was created and saved in the system.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The generated ID (UUID v4) for the configuration. It has to be used when asking for changing any of the configuration parameters. |
vendorId | string | Yes | The vendor that the configuration belongs to. E.g. Verizon, GM, Ford, etc. |
name | string | No | Name of the configuration. |
description | string | No | Description of the configuration. |
geoFence | object | Yes | The GeoJSON representation of geofence. Geofence supports the following geometry types: LineString, Polygon, MultiLineString, and MultiPolygon. The system only supports a single Feature in the FeatureCollection, so only one Line, Polygon, MultiLine or MultiPolygon can be defined within one Geofencing configuration. |
messageStandard | string (one of: etsi, sae, default: sae) | Yes | Select which V2X messaging standard will be used for the message generation. The following options are supported: - "etsi": The message will be generated using the ETSI (European) standard (e.g. DENM). - "sae": The message will be generated using the SAE J2735 (North American) standard (e.g. RSA, TIM). - if not sent while POST, defaults to "sae" - mandatory to send "etsi" standard here, if ETSI messages are being sent in config |
messages | array | Yes | List of predefined messages that belongs to the geofence. These are the messages that are sent out by the system when the Trigger Condition for the message is met. |
isActive | boolean | Yes |