|
|
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.
|
|
|
This use case has a REST API for publishing (sending) the data. There are two types of publishers:
|
|
|
|
|
|
#### Update of the dynamic information of the progress of a sporting event
|
|
|
1. The Organizers of the Event that using the V2 signals, indicate the situation in real time of the 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.
|
|
|
2. 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
|
|
|
|
|
|
- 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"
|
|
|
}
|
|
|
}
|
|
|
]
|
|
|
```
|
|
|
- Body:
|
|
|
|
|
|
```json
|
|
|
{
|
|
|
"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
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
**(*)= 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))
|
|
|
- **(*) actionId** (text): unique identifier of the event.
|
|
|
|
|
|
· **(*)speed** (decimal number): Speed in kilometers per hour at which the element is at the moment the event is sent.
|
|
|
- **(*) beaconId** (text): unique identifier of the beacon (for example, the MAC).
|
|
|
|
|
|
· **(*)beaconStart**: Field that contains the information of the parameters of the initial beacon.
|
|
|
- **(*) 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.
|
|
|
|
|
|
· **(*)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.
|
|
|
- **(*) 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.
|
|
|
|
|
|
· **(*)beaconId** (string): Unique identifier of the beacon (for example, the MAC)
|
|
|
- **(*) lat** (decimal number): latitude of WGS 84 type coordinate where the event was generated.
|
|
|
|
|
|
· **(*)lat** (decimal number): WGS 84 type coordinate latitude where the event was generated
|
|
|
- **(*) hdop** (enter number): DOP value to determine the quality of the GPS information. More information [here](https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation))
|
|
|
|
|
|
· **(*)lon** (decimal number): Longitude of WGS 84 type coordinates where the event was generated
|
|
|
- **(*) speed** (decimal number): speed in kilometers per hour at which the element is at the moment the event is sent
|
|
|
|
|
|
**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.
|
|
|
**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
|
|
|
|
... | ... | |