This endpoint creates a new configuration in the system. The data for the new configuration should be provided as JSON in the body of the POST request. The system will return with a unique ID for the configuration, which is needed for any further manipulation (update or delete) of the configuration.
Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.
thingspace_oauth sessionToken Access/Bearer token needed to authorize the user. The Bearer/Access Token should be acquired by using the ThingSpace Portal (thingspace.verizon.com). For details on how to obtain the token please refer to the
In: header
This is the Session/M2M token needed to authenticate the user. It should be acquired by using the ThingSpace APIs. For detail on how to obtain a Session/M2M token please refer to the
In: header
The vendor's identifier
^[a-zA-Z0-9]+$1 <= length <= 64application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request for /api/v1/application/configurations/geofence POST endpoint. It requires the vendorId, geofence, messageStandard, messages and isActive fields to be populated.
4 <= properties <= 6application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/application/configurations/geofence" \ -H "VendorID: VerizonETX" \ -H "Content-Type: application/json" \ -d '{ "geoFence": { "type": "FeatureCollection", "features": [ { "type": "Feature", "geometry": { "type": "LineString", "coordinates": [ [ -180, -180 ], [ -180, -180 ] ] }, "properties": {} } ] }, "messages": [ { "isPrivate": true, "roadUserType": [ "VulnerableRoadUser" ], "generic": { "messageType": "string", "messageFormat": "string", "payload": "string" } } ], "isActive": true }'{ "id": "a4fcd16a-343d-4527-8203-2f46e3e4ff4b", "vendorId": "VerizonETX", "name": "string", "description": "string", "geoFence": { "type": "FeatureCollection", "features": [ { "type": "Feature", "geometry": { "type": "LineString", "coordinates": [ [ -180, -180 ], [ -180, -180 ] ] }, "properties": {} } ] }, "messageStandard": "etsi", "messages": [ { "isPrivate": true, "roadUserType": [ "VulnerableRoadUser" ], "triggerConditions": [ "enter" ], "limits": [ { "speed": { "min": 0, "max": 0 } } ], "distributionType": [ "Targeted" ], "distributionSchedule": { "repeatPeriod": 5, "duration": 1, "startTime": "2042-07-21T17:32:28Z" }, "generic": { "messageType": "string", "messageFormat": "string", "payload": "string" } } ], "isActive": true}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}Name of the configuration.
^[\w\+\-!()\`\[\]{=};\"':,.\/<>?|\s]+$1 <= length <= 256Description of the configuration.
^[\w\+\-!()\`\[\]{=};\"':,.\/<>?|\s]+$1 <= length <= 2048The 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.
Select which V2X messaging standard will be used for the message generation. The following options are supported:
"sae"Value in
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.
1 <= items <= 10