High Mobility Push API 1.0.0

This document specifies the JSON format for each vehicle property that is made available through High Mobility's streaming and push interfaces.

Servers

  • sandbox.mqtt.high-mobility.com:{port}mqttsandbox

    Sandbox broker

    port
    required
    string

    Secure connection (TLS) is available through port 8883.

    Default value:"8883"
      Allowed values:
    • "8883"
    Security:
    • API key
      • In: user

      Provide your API key as the user and leave the password empty.

    • #instance:sandbox
  • mqtt.high-mobility.com:{port}mqttproduction

    Production broker

    port
    required
    string

    Secure connection (TLS) is available through port 8883.

    Default value:"8883"
      Allowed values:
    • "8883"
    Security:
    • API key
      • In: user

      Provide your API key as the user and leave the password empty.

    • #instance:live

Operations

  • SUB {instance}/{auto_api_level}/{app_id}/{vin}/charging_session/{action}/{property}

    Operation IDlive
    instance
    required
    string
    uid: instance

    live/sandbox

      Allowed values:
    • "live"
    • "sandbox"
    auto_api_level
    required
    string
    uid: auto_api_level

    AutoAPI level

    Const:"level13"
    app_id
    required
    string
    uid: app_id

    Application id

    vin
    required
    string
    uid: vin

    VIN

    capability
    required
    string
    uid: capability

    Capability

    Const:"charging_session"
    action
    required
    string
    uid: action

    Action

    Const:"get"
    property
    required
    string
    uid: property

    Property

    qos
    1

    Accepts one of the following messages:

    • #0Charging Session Business Errors
      object
      uid: charging_session_get_business_errors
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"business_errors"
      required
      object
      non-empty
      required
      restricted any
      array<object>

      Business errors

      data
      required
      string
      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "business_errors",
        "data": {
          "charging_session": {
            "business_errors": [
              {
                "data": "dolore sit qui consectetur sunt",
                "timestamp": "2019-08-24T14:15:22Z"
              }
            ]
          }
        }
      }
      
      This example has been generated automatically.
    • #1Charging Session Calculated Energy Charged
      object
      uid: charging_session_get_calculated_energy_charged
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"calculated_energy_charged"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Calculated amount of energy charged during the session

      required
      object
      unit
      required
      string
        Allowed values:
      • "joules"
      • "kilojoules"
      • "watt_hours"
      • "kilowatt_hours"
      • "ampere_hours"
      value
      required
      number

      Additional properties are NOT allowed.

      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "calculated_energy_charged",
        "data": {
          "charging_session": {
            "calculated_energy_charged": {
              "data": {
                "unit": "kilowatt_hours",
                "value": 88017651.3763172
              },
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #2Charging Session Charging Cost
      object
      uid: charging_session_get_charging_cost
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"charging_cost"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Charging cost information

      required
      object

      Charging cost information

      currency
      required
      string

      Currency ISO code

      calculated_charging_cost
      required
      number

      Calculated charging cost

      calculated_savings
      required
      number

      Calculated savings from charging

      simulated_immediate_charging_cost
      required
      number

      Simulated charging costs

      Additional properties are NOT allowed.

      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "charging_cost",
        "data": {
          "charging_session": {
            "charging_cost": {
              "data": {
                "currency": "aute nulla adipisicing deserunt irure",
                "calculated_charging_cost": 63634430.73076698,
                "calculated_savings": -79649593.49813375,
                "simulated_immediate_charging_cost": -49397217.135194845
              },
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #3Charging Session Displayed Start State Of Charge
      object
      uid: charging_session_get_displayed_start_state_of_charge
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"displayed_start_state_of_charge"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Displayed state of charge at start to the driver

      data
      required
      number

      Percentage value between 0.0 - 1.0 (0% - 100%)

      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "displayed_start_state_of_charge",
        "data": {
          "charging_session": {
            "displayed_start_state_of_charge": {
              "data": -29817892.261693224,
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #4Charging Session Displayed State Of Charge
      object
      uid: charging_session_get_displayed_state_of_charge
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"displayed_state_of_charge"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Displayed state of charge to the driver

      data
      required
      number

      Percentage value between 0.0 - 1.0 (0% - 100%)

      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "displayed_state_of_charge",
        "data": {
          "charging_session": {
            "displayed_state_of_charge": {
              "data": -53902664.44204883,
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #5Charging Session End Time
      object
      uid: charging_session_get_end_time
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"end_time"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      End time of the charging session

      data
      required
      string
      format: date-time
      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "end_time",
        "data": {
          "charging_session": {
            "end_time": {
              "data": "1973-03-21T08:38:02.000Z",
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #6Charging Session Energy Charged
      object
      uid: charging_session_get_energy_charged
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"energy_charged"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Energy charged during the session

      required
      object
      unit
      required
      string
        Allowed values:
      • "joules"
      • "kilojoules"
      • "watt_hours"
      • "kilowatt_hours"
      • "ampere_hours"
      value
      required
      number

      Additional properties are NOT allowed.

      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "energy_charged",
        "data": {
          "charging_session": {
            "energy_charged": {
              "data": {
                "unit": "ampere_hours",
                "value": 26567261.893773735
              },
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #7Charging Session Location
      object
      uid: charging_session_get_location
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"location"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Charging location address

      required
      object

      Charging location address

      municipality
      required
      string

      Municipality component of the address

      formatted_address
      required
      string

      Full formatted address

      street_address
      required
      string

      Street address component

      Additional properties are NOT allowed.

      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "location",
        "data": {
          "charging_session": {
            "location": {
              "data": {
                "municipality": "magna culpa",
                "formatted_address": "dolor velit",
                "street_address": "Ut ad"
              },
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #8Charging Session Odometer
      object
      uid: charging_session_get_odometer
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"odometer"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      The vehicle odometer value in a given units

      required
      object
      unit
      required
      string
        Allowed values:
      • "meters"
      • "millimeters"
      • "centimeters"
      • "decimeters"
      • "kilometers"
      • "megameters"
      • "inches"
      • "feet"
      • "yards"
      • "miles"
      • "scandinavian_miles"
      • "nautical_miles"
      value
      required
      number

      Additional properties are NOT allowed.

      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "odometer",
        "data": {
          "charging_session": {
            "odometer": {
              "data": {
                "unit": "kilometers",
                "value": 3032399.5877975225
              },
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #9Charging Session Preconditioning State
      object
      uid: charging_session_get_preconditioning_state
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"preconditioning_state"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Preconditioning is active or not

      data
      required
      string

      Active state

        Allowed values:
      • "inactive"
      • "active"
      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "preconditioning_state",
        "data": {
          "charging_session": {
            "preconditioning_state": {
              "data": "active",
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #10Charging Session Public Charging Points
      object
      uid: charging_session_get_public_charging_points
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"public_charging_points"
      required
      object
      non-empty
      required
      restricted any
      array<object>

      Matching public charging points.

      required
      object

      Charging point

      city
      required
      string

      City the charging point is in.

      postal_code
      required
      string

      Postal code the charging point is at.

      street
      required
      string

      Street address the chargin point is at.

      provider
      required
      string

      The provider name of the charging point.

      Additional properties are NOT allowed.

      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "public_charging_points",
        "data": {
          "charging_session": {
            "public_charging_points": [
              {
                "data": {
                  "city": "mollit amet velit dolore non",
                  "postal_code": "sint ullamco",
                  "street": "consectetur pariatur laborum",
                  "provider": "pariatur dolor"
                },
                "timestamp": "2019-08-24T14:15:22Z"
              }
            ]
          }
        }
      }
      
      This example has been generated automatically.
    • #11Charging Session Start Time
      object
      uid: charging_session_get_start_time
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"start_time"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Start time of the charging session

      data
      required
      string
      format: date-time
      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "start_time",
        "data": {
          "charging_session": {
            "start_time": {
              "data": "2008-11-04T22:14:47.000Z",
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #12Charging Session Time Zone
      object
      uid: charging_session_get_time_zone
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"time_zone"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Time zone of the charging session

      data
      required
      string
      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "time_zone",
        "data": {
          "charging_session": {
            "time_zone": {
              "data": "aute dolor fugiat",
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.
    • #13Charging Session Total Charging Duration
      object
      uid: charging_session_get_total_charging_duration
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"charging_session"
      property
      required
      string
      Const:"total_charging_duration"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Total time charging was active during the session

      required
      object
      unit
      required
      string
        Allowed values:
      • "seconds"
      • "minutes"
      • "hours"
      • "days"
      • "weeks"
      • "months"
      • "milliseconds"
      value
      required
      number

      Additional properties are NOT allowed.

      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
        "version": 1,
        "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
        "vin": "VFXXXXXXXXXXXXXXX",
        "capability": "charging_session",
        "property": "total_charging_duration",
        "data": {
          "charging_session": {
            "total_charging_duration": {
              "data": {
                "unit": "milliseconds",
                "value": 5532622.88625209
              },
              "timestamp": "2019-08-24T14:15:22Z"
            }
          }
        }
      }
      
      This example has been generated automatically.

Messages

  • #1Charging Session Business Errors
    object
    uid: charging_session_get_business_errors
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"business_errors"
    required
    object
    non-empty
    required
    restricted any
    array<object>

    Business errors

    data
    required
    string
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #2Charging Session Calculated Energy Charged
    object
    uid: charging_session_get_calculated_energy_charged
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"calculated_energy_charged"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Calculated amount of energy charged during the session

    required
    object
    unit
    required
    string
      Allowed values:
    • "joules"
    • "kilojoules"
    • "watt_hours"
    • "kilowatt_hours"
    • "ampere_hours"
    value
    required
    number

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #3Charging Session Charging Cost
    object
    uid: charging_session_get_charging_cost
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"charging_cost"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Charging cost information

    required
    object

    Charging cost information

    currency
    required
    string

    Currency ISO code

    calculated_charging_cost
    required
    number

    Calculated charging cost

    calculated_savings
    required
    number

    Calculated savings from charging

    simulated_immediate_charging_cost
    required
    number

    Simulated charging costs

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #4Charging Session Displayed Start State Of Charge
    object
    uid: charging_session_get_displayed_start_state_of_charge
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"displayed_start_state_of_charge"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Displayed state of charge at start to the driver

    data
    required
    number

    Percentage value between 0.0 - 1.0 (0% - 100%)

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #5Charging Session Displayed State Of Charge
    object
    uid: charging_session_get_displayed_state_of_charge
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"displayed_state_of_charge"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Displayed state of charge to the driver

    data
    required
    number

    Percentage value between 0.0 - 1.0 (0% - 100%)

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #6Charging Session End Time
    object
    uid: charging_session_get_end_time
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"end_time"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    End time of the charging session

    data
    required
    string
    format: date-time
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #7Charging Session Energy Charged
    object
    uid: charging_session_get_energy_charged
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"energy_charged"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Energy charged during the session

    required
    object
    unit
    required
    string
      Allowed values:
    • "joules"
    • "kilojoules"
    • "watt_hours"
    • "kilowatt_hours"
    • "ampere_hours"
    value
    required
    number

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #8Charging Session Location
    object
    uid: charging_session_get_location
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"location"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Charging location address

    required
    object

    Charging location address

    municipality
    required
    string

    Municipality component of the address

    formatted_address
    required
    string

    Full formatted address

    street_address
    required
    string

    Street address component

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #9Charging Session Odometer
    object
    uid: charging_session_get_odometer
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"odometer"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    The vehicle odometer value in a given units

    required
    object
    unit
    required
    string
      Allowed values:
    • "meters"
    • "millimeters"
    • "centimeters"
    • "decimeters"
    • "kilometers"
    • "megameters"
    • "inches"
    • "feet"
    • "yards"
    • "miles"
    • "scandinavian_miles"
    • "nautical_miles"
    value
    required
    number

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #10Charging Session Preconditioning State
    object
    uid: charging_session_get_preconditioning_state
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"preconditioning_state"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Preconditioning is active or not

    data
    required
    string

    Active state

      Allowed values:
    • "inactive"
    • "active"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #11Charging Session Public Charging Points
    object
    uid: charging_session_get_public_charging_points
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"public_charging_points"
    required
    object
    non-empty
    required
    restricted any
    array<object>

    Matching public charging points.

    required
    object

    Charging point

    city
    required
    string

    City the charging point is in.

    postal_code
    required
    string

    Postal code the charging point is at.

    street
    required
    string

    Street address the chargin point is at.

    provider
    required
    string

    The provider name of the charging point.

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #12Charging Session Start Time
    object
    uid: charging_session_get_start_time
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"start_time"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Start time of the charging session

    data
    required
    string
    format: date-time
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #13Charging Session Time Zone
    object
    uid: charging_session_get_time_zone
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"time_zone"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Time zone of the charging session

    data
    required
    string
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #14Charging Session Total Charging Duration
    object
    uid: charging_session_get_total_charging_duration
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"total_charging_duration"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Total time charging was active during the session

    required
    object
    unit
    required
    string
      Allowed values:
    • "seconds"
    • "minutes"
    • "hours"
    • "days"
    • "weeks"
    • "months"
    • "milliseconds"
    value
    required
    number

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

Schemas

  • version
    number
    uid: version
  • message_id
    string
    uid: message_id
  • vin
    string
    uid: vin
  • timestamp
    string
    format: date-timeuid: timestamp
  • object
    uid: charging_session_get_business_errors
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"business_errors"
    required
    object
    non-empty
    required
    restricted any
    array<object>

    Business errors

    data
    required
    string
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_calculated_energy_charged
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"calculated_energy_charged"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Calculated amount of energy charged during the session

    required
    object
    unit
    required
    string
      Allowed values:
    • "joules"
    • "kilojoules"
    • "watt_hours"
    • "kilowatt_hours"
    • "ampere_hours"
    value
    required
    number

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_charging_cost
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"charging_cost"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Charging cost information

    required
    object

    Charging cost information

    currency
    required
    string

    Currency ISO code

    calculated_charging_cost
    required
    number

    Calculated charging cost

    calculated_savings
    required
    number

    Calculated savings from charging

    simulated_immediate_charging_cost
    required
    number

    Simulated charging costs

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_displayed_start_state_of_charge
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"displayed_start_state_of_charge"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Displayed state of charge at start to the driver

    data
    required
    number

    Percentage value between 0.0 - 1.0 (0% - 100%)

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_displayed_state_of_charge
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"displayed_state_of_charge"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Displayed state of charge to the driver

    data
    required
    number

    Percentage value between 0.0 - 1.0 (0% - 100%)

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_end_time
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"end_time"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    End time of the charging session

    data
    required
    string
    format: date-time
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_energy_charged
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"energy_charged"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Energy charged during the session

    required
    object
    unit
    required
    string
      Allowed values:
    • "joules"
    • "kilojoules"
    • "watt_hours"
    • "kilowatt_hours"
    • "ampere_hours"
    value
    required
    number

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_location
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"location"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Charging location address

    required
    object

    Charging location address

    municipality
    required
    string

    Municipality component of the address

    formatted_address
    required
    string

    Full formatted address

    street_address
    required
    string

    Street address component

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_odometer
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"odometer"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    The vehicle odometer value in a given units

    required
    object
    unit
    required
    string
      Allowed values:
    • "meters"
    • "millimeters"
    • "centimeters"
    • "decimeters"
    • "kilometers"
    • "megameters"
    • "inches"
    • "feet"
    • "yards"
    • "miles"
    • "scandinavian_miles"
    • "nautical_miles"
    value
    required
    number

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_preconditioning_state
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"preconditioning_state"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Preconditioning is active or not

    data
    required
    string

    Active state

      Allowed values:
    • "inactive"
    • "active"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_public_charging_points
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"public_charging_points"
    required
    object
    non-empty
    required
    restricted any
    array<object>

    Matching public charging points.

    required
    object

    Charging point

    city
    required
    string

    City the charging point is in.

    postal_code
    required
    string

    Postal code the charging point is at.

    street
    required
    string

    Street address the chargin point is at.

    provider
    required
    string

    The provider name of the charging point.

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_start_time
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"start_time"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Start time of the charging session

    data
    required
    string
    format: date-time
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_time_zone
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"time_zone"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Time zone of the charging session

    data
    required
    string
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: charging_session_get_total_charging_duration
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"charging_session"
    property
    required
    string
    Const:"total_charging_duration"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Total time charging was active during the session

    required
    object
    unit
    required
    string
      Allowed values:
    • "seconds"
    • "minutes"
    • "hours"
    • "days"
    • "weeks"
    • "months"
    • "milliseconds"
    value
    required
    number

    Additional properties are NOT allowed.

    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.