This use case has a REST API for publishing (sending) the data. There are two types of publishers:
-
The Organizers of the Event that using the V2 signals, indicate the situation in real time of the event.
-
The devices distributed in the event, cones, which indicate the different road closures that affect the event in question.
Required methods for integration with V2 signals
Update of the dynamic information of the progress of a sporting event
The event is the main part of this data ingestion API. With this event you can update the dynamic information of the sporting event. With it, the information received by the V2 signals of the escort cars located at the head and tail of the sporting event will be updated.The information will be sent with the following fields in the following format:
Information about the endpoint:
-
Method: POST
-
URL: {baseUrl}/v1/tracking/event
-
Body:
{
"actionId": "CLI_235",
"beaconId": "cff92179-dc0a-47da-bd9e-5e9c5b14d251",
"beaconTypeId": 1,
"timestamp": "2021-03-15T13:34:00.000Z",
"lon" : "-7.009654361999935",
"lat" : "38.52736428400004",
"hdop" : 5,
"speed": 50
}
* = Campo requerido
-
(*) actionId (text): unique identifier of the event.
-
(*) beaconId (text): unique identifier of the beacon (for example, the MAC).
-
(*) beaconTypeId (enter number): Beacon type identifier. Possible values in /beaconTypes. 1=Start, 2=End. The values (3 = Intermediate and 4 = Unique) do not apply to this type of event.
-
(*) timestamp (UTC date): date and time in UTC format of the moment in which the event was generated. It needs to be a maximum of 30 seconds old with respect to UTC time.
-
(*) lon (decimal number): longitude of WGS 84 type coordinates where the event was generated.
-
(*) lat (decimal number): latitude of WGS 84 type coordinate where the event was generated.
-
(*) hdop (enter number): DOP value to determine the quality of the GPS information. More information here
-
(*) speed (decimal number): speed in kilometers per hour at which the element is at the moment the event is sent
Note: To identify an event that requires dynamic tracking (type of tracking that requires two beacons), each one must be identified with its respective position in the test:
- If the beacon is on the lead vehicle, the value of the field beaconTypeId will be 1= Start.
- If the beacon is on the trailing vehicle, the value of the field beaconTypeId will be 2= End.
Update of the static information of the progress of a sporting event
The event is the main part of this data ingestion API. With this event you can update the dynamic information of the sporting event. With it, the information received by the V2 signals of the escort cars located at the head and tail of the event will be updated. The static information can be differentiated, the following body will be sent, which unlike the dynamic does not contain the beaconEnd field.
-
Method: POST
-
URL: {baseUrl}/v1/tracking/event
-
Updates the static information data of a sports plan
{ "actionId": "1", "timestamp": "2000-12-12T15:00:00", "hdop": "", "speed": "", "beaconStart": { "beaconId": "1", "lon": "-8.103828007999937", "lat": "42.437257490000036" } }
* = Required field
· (*)actionId (string): Unique identifier of the event
· (*)timestamp (UTC Date): Date and time in UTC format of the moment in which the event was generated. It needs to be a maximum of 30 seconds old with respect to UTC time. The date must end with the character 'Z' that marks that it is in UTC.
· (*)hdop: DOP value to determine the quality of the GPS information. More information here
· (*)speed (decimal number): Speed in kilometers per hour at which the element is at the moment the event is sent
· (*)beaconStart: Field that contains the information of the parameters of the initial beacon.
· (*)beaconId (string): Unique identifier of the beacon (for example, the MAC)
· (*)lat (decimal number): WGS 84 type coordinate latitude where the event was generated
· (*)lon (decimal number): Longitude of WGS 84 type coordinates where the event was generated
Note: If it only contains the beaconStart field it corresponds to static information, if it contains the beaconStart field and beaconEnd it corresponds to dynamic information.
Methods required for the integration of connected cones
Publication of the location of a cone
The cones are used to cut the different roads that are on the perimeter of the sports event. The cone will send its positioning every certain period of time. Once the cone is deactivated, it means that the road has been cleared and circulation can be restored on it.
-
Method: POST
-
URL: {baseUrl}/v1/events
-
Response:
{ "actionId": "{{$guid}}", "beaconId": "862506044003724", "beaconTypeId": 4, "timestamp": "{{$isoTimestamp}}", "lat": 41.456123, "lon": 1.928123, "vehicleTypeId": 0, "hdop": 1, "deviceTypeId": 3, "deviceUseTypeId": 3, "speed": 0 }
(*)= Required field
· (*)actionId (string): Unique identifier of the event
· (*)beaconId (string): Unique identifier of the beacon (for example, the MAC)
· (*)beaconTypeId (integer): Beacon type identifier. The only possible value is /beaconTypes. 4=Unique
· (*)timestamp (UTC Date): Date and time in UTC format of the moment in which the event was generated. It needs to be a maximum of 30 seconds old with respect to UTC time. The date must end with the character 'Z' that marks that it is in UTC.
· (*)lat (decimal number): WGS 84 type coordinate latitude where the event was generated
· (*)lon (decimal number): Longitude of WGS 84 type coordinates where the event was generated
· (*)vehicleTypeId (integer): Identifier of the type of event. Possible values in /eventTypes. 1 = VAC on the way, 2 = VAC in intervention, 3 = VAC intervention completed.
· (*)hdop: DOP value to determine the quality of the GPS information. More information here
· (*)deviceTypeId: Identifier of the type of device from which the information is sent. The value is /DeviceTypes. 3= Cone.
· (*)deviceUseTypeId: Identifier of the type of use of the device that sends the information. deviceUseTypeId =3 for infrastructure
· (*)speed (decimal number): speed in kilometers per hour at which the element is at the moment the event is sent