Event - dgt30-eng/Use-case-1 GitHub Wiki
The set of message attributes is described in the message
{
"idcompany":"v16.example.com",
"token": "asdfasdfasdfasdf",
"actionid": "1",
"detection_time": "2020-02-24T07:17:27Z",
"lon": -3.5 ,
"lat": 40.5,
"device_event_type": 1,
"device_event_type_value": 1,
"information_quality": 1,
"heading": 100,
"station_type": 1,
"speed": 0,
"use": 1
}
Atribute | Desc |
---|---|
idcompany | Company identifier |
actionid | Unique identifier of the event anonymizing the source device, from activation to deactivation |
token | Token generated for client platform during authentication |
detection_time | Timestamp of the instant in which the event occurs, in format ISO 8601 YYYY-MM-DDTHH:MM:SSZ |
lon | Geographic longitude of the event in WGS84 coordinates |
Lat | Geographic latitude of the event in WGS84 coordinates |
device_event_type | Event type 1 – Vehicle stopped |
device_event_type_value | Event type value. 1 – activation; 2 – activated; 3 - deactivation |
information_quality | HDOP value |
heading | Vehicle orientation in degrees from North to East |
speed | Speed, in our case 0, since the vehicle must be at rest |
use | Use corresponding to the mode of transport |
-
Method: GET
-
URL: {baseUrl}/v1/idcompany
-
Body:
{
"info_code": 0,
"info_desc": "",
"data": [
{
"idEmpresa": 38
}
]
}
-
In order to maintain the quality of the messages, the following requirements shall apply to the content of the messages
-
The order, quantity and frequency of the messages are set out below:
- Activation type events, a single message
- Activated type events, as many messages as the activity of the beacon lasts, with a frequency of 100 seconds between messages
- Deactivation type events, a single message.
-
The position provided by the GPS must not have an error greater than 5 metres.
-
Events will be accepted with a maximum age of 15 seconds with respect to UTC time, and that is not a future data. In case of non-compliance, an HTTP Status: 400 Bad Request Error code: 24 will be received in case of a future event. In case of a past event an HTTP Status: 400 Bad Request Error code: 30 will be received.