|
|
The event is the main part of this data ingestion API. This element is where the information of the event generated by each of the devices will be sent to the platform in real time.
|
|
|
|
|
|
- Method: POST
|
|
|
|
|
|
- URL: {baseUrl}/v1/**events**
|
|
|
|
|
|
- Body:
|
|
|
|
|
|
```
|
|
|
{
|
|
|
"companyId": "v2client.acme.com",
|
|
|
"actionId": "CLI_235",
|
|
|
"dgtId": "DGT_10928",
|
|
|
"dgtSecurityId": "DGT_SEC_18293",
|
|
|
"beaconId": "cff92179-dc0a-47da-bd9e-5e9c5b14d251",
|
|
|
"beaconTypeId": 1,
|
|
|
"timestamp": "2021-03-15T13:34:00.000",
|
|
|
"lon": -3.45368,
|
|
|
"lat": 40.36586,
|
|
|
"vehicleTypeId": 1,
|
|
|
"informationQualityId": 1,
|
|
|
"deviceTypeId": 1,
|
|
|
"deviceUseTypeId": 1,
|
|
|
"speed": 120
|
|
|
}
|
|
|
```
|
|
|
|
|
|
**\* = Required field**
|
|
|
|
|
|
- companyId * (text): certificate CN
|
|
|
|
|
|
- actionId * (text): unique event identifier
|
|
|
|
|
|
- dgtId (text)
|
|
|
|
|
|
- dgtSecurityId (text)
|
|
|
|
|
|
- beaconId * (text): unique beacon identifier (for example, the MAC)
|
|
|
|
|
|
- beaconTypeId * (integer number): beacon type identifier. Possible values in / beaconTypes
|
|
|
|
|
|
- timestamp * (UTC time): date and time in UTC format of when the event was generated. It must be a maximum of 30 seconds old with respect to UTC time
|
|
|
|
|
|
- lon * (decimal number): longitude in WGS 84 coordinate system where the event was generated
|
|
|
|
|
|
- lat * (decimal number): latitude in WGS 84 coordinate system where the event was generated
|
|
|
|
|
|
- vehicleTypeId* (integer number): vehicle type identifier. Possible values in / vehicleTypes
|
|
|
|
|
|
- informationQualityId * (integer number): identifier of the type of information quality. Possible values in / informationQualities
|
|
|
|
|
|
- deviceTypeId * (integer number): identifier of the type of device from which the information is sent. Possible values in / deviceTypes
|
|
|
|
|
|
- deviceUseTypeId * (integer number): identifier of the type of use of the device that sends the information. Possible values in / deviceUseTypes
|
|
|
|
|
|
- speed (integer number): speed measured in kilometers per hour at which the element is at the moment it sends the event |