|
|
These *endpoints* are methods of the use case that have the objective of publishing information related to sporting events and the publication of cone information.
|
|
|
|
|
|
#### 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 **dynamic** information can be differentiated from the static **contains the beaconStart and beaconEnd** fields.
|
|
|
|
|
|
- Method: POST
|
|
|
|
|
|
- URL: {baseUrl}/v1/tracking/event
|
|
|
|
|
|
- Update the dynamic data of the sporting event
|
|
|
|
|
|
```json
|
|
|
[
|
|
|
{
|
|
|
"actionId": "1",
|
|
|
"timestamp": "2000-12-12T15:00:00",
|
|
|
"hdop" : "",
|
|
|
"speed": "",
|
|
|
"beaconStart" : {
|
|
|
"beaconId" : "1",
|
|
|
"lon" : "-8.103828007999937",
|
|
|
"lat" : "42.437257490000036"
|
|
|
},
|
|
|
"beaconEnd" : {
|
|
|
"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](https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation))
|
|
|
|
|
|
· **(*)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
|
|
|
|
|
|
· **(*)beaconEnd**: Field that contains the information of the parameters of the final 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 contains the beaconStart field and beaconEnd it corresponds to dynamic information, if it only contains the beaconStart field it corresponds to static information.
|
|
|
|
|
|
#### 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
|
|
|
|
|
|
```json
|
|
|
{
|
|
|
"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](https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation))
|
|
|
|
|
|
· **(*)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.
|
|
|
|
|
|
#### Publication of the location of a cone
|
|
|
|
|
|
- Method: POST
|
|
|
|
|
|
- URL: {baseUrl}/v1/events
|
|
|
|
|
|
- Response:
|
|
|
|
|
|
```json
|
|
|
{
|
|
|
"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](https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation))
|
|
|
|
|
|
· **(*)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
|
|
|
|
|
|
#### |