Schema Documentation
Vehicle Telemetry Channel
Get Vehicle Telemetry messages
The unique identifier of the Company.
A Vehicle internal number
Accepts the following message:
{
"vehicle": {
"companyId": "1877c37hcebb4c4f808628d99d7bs0df",
"divisionId": "1877c37hcebb4c4f808628d99d7bs0df",
"internalNumber": "2255",
"vin": "2GBE4C3126H66WC5A",
"bmsIds": [
"FD43DE0DC4B6"
]
},
"gps": {
"lat": 0,
"lon": 0,
"alt": 0,
"satellites": 0,
"speed": 0,
"angle": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"ignition": {
"value": true,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"totalFuelConsumed": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"odometer": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"soc": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
}
}
Vehicle Telemetry Channel
Publish Vehicle Telemetry messages
The unique identifier of the Company.
A Vehicle internal number
Accepts the following message:
{
"vehicle": {
"companyId": "1877c37hcebb4c4f808628d99d7bs0df",
"divisionId": "1877c37hcebb4c4f808628d99d7bs0df",
"internalNumber": "2255",
"vin": "2GBE4C3126H66WC5A",
"bmsIds": [
"FD43DE0DC4B6"
]
},
"gps": {
"lat": 0,
"lon": 0,
"alt": 0,
"satellites": 0,
"speed": 0,
"angle": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"ignition": {
"value": true,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"totalFuelConsumed": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"odometer": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"soc": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
}
}
Charger State Topic
Receive Charger State messages
The unique identifier of the Company.
The unique identifier of the Depot.
The unique identifier of the charger.
The unique identifier of the connector.
Accepts the following message:
A message providing the complete state of a charging session.
{
"timestamp": "2023-06-30T00:00:00.000Z",
"sessionId": 0,
"idTag": "string",
"vehicle": {
"companyId": "1877c37hcebb4c4f808628d99d7bs0df",
"divisionId": "1877c37hcebb4c4f808628d99d7bs0df",
"internalNumber": "2255",
"vin": "2GBE4C3126H66WC5A",
"bmsIds": [
"FD43DE0DC4B6"
]
},
"chargePoint": {
"chargerId": "string",
"chargerName": "string",
"connectorId": 0,
"connectorName": "string"
},
"sessionStart": "2023-06-30T00:00:00.000Z",
"sessionEnd": "2023-06-30T00:00:00.000Z",
"socStart": 0,
"consumedEnergy": 0,
"chargingCost": {
"amount": 0,
"currency": "string"
},
"lastPower": 0,
"lastSoc": 0,
"lastVoltage": 0,
"estimatedCompletionTime": "2023-06-30T00:00:00.000Z",
"status": "PENDING",
"errorCode": "E1234"
}
Charger Connection Status Topic
Publish Charger Connection Status messages
The unique identifier of the Company.
The unique identifier of the Depot.
The unique identifier of the charger.
Accepts the following message:
A message providing the current connection status of a charger.
{
"timestamp": "2023-06-30T00:00:00.000Z",
"status": "ONLINE"
}
Connector Status Topic
Publish Connector Status messages
The unique identifier of the Company.
The unique identifier of the Depot.
The unique identifier of the charger.
The unique identifier of the connector.
Accepts the following message:
A message providing the current status of a charger's connector.
{
"timestamp": "2023-06-30T00:00:00.000Z",
"status": "AVAILABLE"
}
Charging Session State Topic
Publish Charging Session State messages
The unique identifier of the Company.
The unique identifier of the Depot.
The unique identifier of the charger.
The unique identifier of the connector.
Accepts the following message:
A message providing the current state of a charging session.
{
"timestamp": "2023-06-30T00:00:00.000Z",
"sessionId": 0,
"idTag": "string",
"sessionStart": "2023-06-30T00:00:00.000Z",
"sessionEnd": "2023-06-30T00:00:00.000Z",
"lastMeterValue": 0,
"lastPower": 0,
"lastSoc": 0,
"lastVoltage": 0,
"lastCurrent": 0,
"lastTemperature": 0,
"stopReason": "EMERGENCY_STOP"
}
Charging Profile Configuration Request Topic
Receive Charging Profile Configuration Command
The unique identifier of the Company.
The unique identifier of the Depot.
The unique identifier of the charger.
Accepts the following message:
A message providing new charging profile configuration request
In case of setting a profile (requestType = "SET_PROFILE") all the fields are supposed to be provided. In case of clearing the profile (requestType = "CLEAR_PROFILE") "startSchedule" and "charging periods" will be omitted
{
"timestamp": "2023-06-30T00:00:00.000Z",
"requestId": "1877c37hcebb4c4f808628d99d7bs0df",
"requestType": "SET_PROFILE",
"sessionId": 0,
"connectorId": 0,
"stackLevel": 0,
"purpose": "TX_DEFAULT_PROFILE",
"startSchedule": "2023-06-30T00:00:00.000Z",
"chargingPeriods": [
{
"from": "2023-06-30T00:00:00.000Z",
"power": 0
}
]
}
Charging Profile Configuration Response Topic
Publish Charging Profile Configuration Result messages
The unique identifier of the Company.
The unique identifier of the Depot.
The unique identifier of the charger.
The unique identifier of the correlated request.
Accepts the following message:
A message providing new charging profile configuration result
{
"timestamp": "2023-06-30T00:00:00.000Z",
"status": "ACCEPTED"
}
A Vehicle Telemetry message
A message providing the complete state of a charging session.
A message providing the current connection status of a charger.
A message providing the current status of a charger's connector.
A message providing the current state of a charging session.
A message providing new charging profile configuration request
In case of setting a profile (requestType = "SET_PROFILE") all the fields are supposed to be provided. In case of clearing the profile (requestType = "CLEAR_PROFILE") "startSchedule" and "charging periods" will be omitted
A message providing new charging profile configuration result
In case of setting a profile (requestType = "SET_PROFILE") all the fields are supposed to be provided. In case of clearing the profile (requestType = "CLEAR_PROFILE") "startSchedule" and "charging periods" will be omitted