Periodic Data
caution
The vehicle data inside items[] is an optional value included in the response only when received.
Request Info
- Protocol: HTTPS (Mandatory)
- Method: POST
Request Header
The request header includes the following values.
| Key | Description | Type | (Sample) Value |
|---|---|---|---|
| Content-Type | Content Type | String | application/json; charset=utf-8 |
| X-API-Version | Fleet API version | String | v1.0 |
| X-42dot-transmissionType | Collection/Transmission interval information | String | 10S_30S |
| X-Custom-Key | (Optional) Custom header registered by the user when registering a Webhook | String | My custom value |
Payload Schema
| Key | Description | Type | Sample value | Collection/Transmission cycle (s) |
|---|---|---|---|---|
| vin | Vehicle Identification Number | String | HMGSDV00000000001 | - |
| vehicleId | Vehicle Unique ID | String | e79049fb-e744-11ef-8dd9-f56aaa011ede | - |
| itemsCount | Number of items | Integer | 3 | - |
| items | Vehicle data array | Object Array | - | |
| items[].messageTime | Time vehicle data was recorded (ISO 8601) | String | 2025-02-12T08:12:58.628000000Z | - |
| items[].data | Vehicle Data Object | Usage (object) | - | |
| items[].data.Vehicle.Latitude | Latitude | ValueObject<Double> | 10 / 30 | |
| items[].data.Vehicle.Longitude | Longitude | ValueObject<Double> | 10 / 30 | |
| items[].data.Vehicle.Speed | Vehicle Speed (km/h) | ValueObject<Double> | 10 / 30 | |
| items[].data.Vehicle.Odometer | Odometer (km) | ValueObject<Double> | 10 / 30 | |
| items[].data.AuxiliaryBattery.Voltage | 12V Battery Voltage (Volt) | ValueObject<Double> | 10 / 30 | |
| items[].data.Vehicle.Tire.Pressure.FrontLeft | Tire Pressure FL | ValueObject<Double> | 10 / 30 | |
| items[].data.Vehicle.Tire.Pressure.FrontRight | Tire Pressure FR | ValueObject<Double> | 10 / 30 | |
| items[].data.Vehicle.Tire.Pressure.RearLeft | Tire Pressure RL | ValueObject<Double> | 10 / 30 | |
| items[].data.Vehicle.Tire.Pressure.RearRight | Tire Pressure RR | ValueObject<Double> | 10 / 30 | |
| items[].data.ChargeSystem.Active | Charging Status | ValueObject<String> | [ "ACTIVE", "INACTIVE" ] | 10 / 30 |
| items[].data.TractionBattery.SOC | Battery SOC (%) | ValueObject<Double> | 10 / 30 | |
| items[].data.Vehicle.DTE | Driving Range (km) | ValueObject<Double> | 10 / 30 | |
| items[].data.TractionBattery.RegenerativeEnergy | Regenerative Energy (kWh) | ValueObject<Double> | 10 / 30 |
Payload examples
Payload example 1
{
"vin": "HMGSDV00000000001",
"vehicleId": "e79049fb-e744-11ef-8dd9-f56aaa011ede",
"itemsCount": 3,
"items": [
{
"messageTime": "2025-02-12T08:12:58.628000000Z",
"data": {
"Vehicle": {
"Speed": {
"value": 33.0,
"eventTime": "2025-02-12T08:12:58.628000000Z"
},
"Odometer": {
"value": 85488.20000000001,
"eventTime": "2025-02-12T08:12:58.628000000Z"
},
"Longitude": {
"value": -154.91031883652636,
"eventTime": "2025-02-12T08:12:58.628000000Z"
},
"Latitude": {
"value": -18.69372709987225,
"eventTime": "2025-02-12T08:12:58.628000000Z"
}
}
}
},
{
"messageTime": "2025-02-12T08:12:48.529000000Z",
"data": {
"Vehicle": {
"Speed": {
"value": 33.0,
"eventTime": "2025-02-12T08:12:48.529000000Z"
},
"Odometer": {
"value": 85488.20000000001,
"eventTime": "2025-02-12T08:12:48.529000000Z"
},
"Longitude": {
"value": -19.375769325931543,
"eventTime": "2025-02-12T08:12:48.529000000Z"
},
"Latitude": {
"value": -76.1095325617343,
"eventTime": "2025-02-12T08:12:48.529000000Z"
}
}
}
},
{
"messageTime": "2025-02-12T08:12:38.433000000Z",
"data": {
"Vehicle": {
"Speed": {
"value": 33.0,
"eventTime": "2025-02-12T08:12:38.433000000Z"
},
"Odometer": {
"value": 85488.20000000001,
"eventTime": "2025-02-12T08:12:38.433000000Z"
},
"Longitude": {
"value": -14.687766053318,
"eventTime": "2025-02-12T08:12:38.433000000Z"
},
"Latitude": {
"value": 0.07465427590453544,
"eventTime": "2025-02-12T08:12:38.433000000Z"
}
}
}
}
]
}
Payload example 2
{
"vin": "HMGSDV00000000001",
"vehicleId": "e79049fb-e744-11ef-8dd9-f56aaa011ede",
"itemsCount": 1,
"items": [
{
"messageTime": "2025-02-12T08:12:58.628000000Z",
"data": {
"Tire": {
"Pressure": {
"FrontLeft": {
"value": 37.0,
"eventTime": "2025-02-12T08:12:58.628000000Z"
},
"RearRight": {
"value": 37.0,
"eventTime": "2025-02-12T08:12:58.628000000Z"
},
"RearLeft": {
"value": 37.0,
"eventTime": "2025-02-12T08:12:58.628000000Z"
},
"FrontRight": {
"value": 37.0,
"eventTime": "2025-02-12T08:12:58.628000000Z"
}
}
},
"AuxiliaryBattery": {
"Voltage": {
"value": 14.685,
"eventTime": "2025-02-12T08:12:58.628000000Z"
}
},
"Acceleration": {
"Longitudinal": {
"value": -0.023326094999999825,
"eventTime": "2025-02-12T08:12:58.628000000Z"
},
"Lateral": {
"value": 0.025875394999999912,
"eventTime": "2025-02-12T08:12:58.628000000Z"
}
}
}
}
]
}
Payload example 3
{
"vin": "HMGSDV00000000001",
"vehicleId": "e79049fb-e744-11ef-8dd9-f56aaa011ede",
"itemsCount": 1,
"items": [
{
"messageTime": "2025-02-12T08:12:58.628000000Z",
"data": {
"ChargeSystem": {
"Active": {
"value": "INACTIVE",
"eventTime": "2024-12-12T08:24:09.107000000Z"
}
},
"Vehicle": {
"DTE": {
"value": 412.0,
"eventTime": "2025-02-12T08:12:58.628000000Z"
}
},
"TractionBattery": {
"SOC": {
"value": 95.0,
"eventTime": "2025-02-12T08:12:58.628000000Z"
}
}
}
}
]
}