Tenix Open Data Platform API - MQTT v1

Schema Documentation

Operations

  • SEND tenix/vehicle/todp/{companyId}/{internalNumber}/telemetry

    Vehicle Telemetry Channel

    Get Vehicle Telemetry messages

    Operation IDgetVehicleTelemetry
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    A Vehicle internal number

      Examples values:
    • "2255"
    • "2067"

    Accepts the following message:

    A Vehicle Telemetry message

    A Vehicle Telemetry message

    object

    Examples

  • RECEIVE tenix/vehicle/{companyId}/todp/{internalNumber}/telemetry

    Vehicle Telemetry Channel

    Publish Vehicle Telemetry messages

    Operation IDpublishVehicleTelemetry
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    A Vehicle internal number

      Examples values:
    • "2255"
    • "2067"

    Accepts the following message:

    A Vehicle Telemetry message

    A Vehicle Telemetry message

    object

    Examples

  • SEND tenix/charge/todp/{companyId}/{depotId}/{chargerId}/{connectorId}/session

    Charger State Topic

    Receive Charger State messages

    Operation IDgetChargingSessionState
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    The unique identifier of the Depot.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    chargerId
    required
    string

    The unique identifier of the charger.

    connectorId
    required
    number

    The unique identifier of the connector.

    Accepts the following message:

    Charging Session State

    A message providing the complete state of a charging session.

    object

    Examples

  • RECEIVE tenix/charge/{companyId}/todp/{depotId}/{chargerId}/status

    Charger Connection Status Topic

    Publish Charger Connection Status messages

    Operation IDpublishChargerConnectionStatus
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    The unique identifier of the Depot.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    chargerId
    required
    string

    The unique identifier of the charger.

    Accepts the following message:

    Charger Connection Status

    A message providing the current connection status of a charger.

    object

    Examples

  • RECEIVE tenix/charge/{companyId}/todp/{depotId}/{chargerId}/{connectorId}/status

    Connector Status Topic

    Publish Connector Status messages

    Operation IDpublishConnectorStatus
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    The unique identifier of the Depot.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    chargerId
    required
    string

    The unique identifier of the charger.

    connectorId
    required
    number

    The unique identifier of the connector.

    Accepts the following message:

    Connector Status

    A message providing the current status of a charger's connector.

    object

    Examples

  • RECEIVE tenix/charge/{companyId}/todp/{depotId}/{chargerId}/{connectorId}/session

    Charging Session State Topic

    Publish Charging Session State messages

    Operation IDpublishChargingSessionState
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    The unique identifier of the Depot.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    chargerId
    required
    string

    The unique identifier of the charger.

    connectorId
    required
    number

    The unique identifier of the connector.

    Accepts the following message:

    Charging Session State Update

    A message providing the current state of a charging session.

    object

    Examples

  • SEND tenix/charge/todp/{companyId}/{depotId}/{chargerId}/charging/profile

    Charging Profile Configuration Request Topic

    Receive Charging Profile Configuration Command

    Operation IDconfigureChargingProfile
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    The unique identifier of the Depot.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    chargerId
    required
    string

    The unique identifier of the charger.

    Accepts the following message:

    Charging Profile Configuration Request

    A message providing new charging profile configuration request

    object

    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

    Examples

  • RECEIVE tenix/charge/{companyId}/todp/{depotId}/{chargerId}/charging/profile/{requestId}

    Charging Profile Configuration Response Topic

    Publish Charging Profile Configuration Result messages

    Operation IDpublishConfigureChargingProfileResponse
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    The unique identifier of the Depot.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    chargerId
    required
    string

    The unique identifier of the charger.

    required
    string

    The unique identifier of the correlated request.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"

    Accepts the following message:

    Charging Profile Configuration Response

    A message providing new charging profile configuration result

    object

    Examples

Messages

  • #1A Vehicle Telemetry messagetelemetry

    A Vehicle Telemetry message

    Message IDtelemetry
    object
  • #2Charging Session StatechargingSessionState

    A message providing the complete state of a charging session.

    Message IDchargingSessionState
    object
  • #3Charger Connection StatuschargerConnectionStatus

    A message providing the current connection status of a charger.

    Message IDchargerConnectionStatus
    object
  • #4Connector StatusconnectorStatus

    A message providing the current status of a charger's connector.

    Message IDconnectorStatus
    object
  • #5Charging Session State UpdatechargingSessionStateUpdate

    A message providing the current state of a charging session.

    Message IDchargingSessionStateUpdate
    object
  • #6Charging Profile Configuration RequestconfigureChargingProfileRequest

    A message providing new charging profile configuration request

    Message IDconfigureChargingProfileRequest
    object

    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

  • #7Charging Profile Configuration ResponseconfigureChargingProfileResponse

    A message providing new charging profile configuration result

    Message IDconfigureChargingProfileResponse
    object

Schemas

  • string
      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
  • vin
    string
      Examples values:
    • "2GBE4C3126H66WC5A"
    • "KM8SGDKB3A847RKMX"
    • "5Y2SN65L661921TVB"
  • string
      Examples values:
    • "2255"
    • "2067"
  • bmsId
    string
      Examples values:
    • "FD43DE0DC4B6"
    • "51BEF9F0EFAE"
    • "A2987A5E09D0"
  • timestamp
    string
    format: date-time
      Examples values:
    • "2023-06-30T00:00:00.000Z"
  • object
  • object
  • object
  • object
  • object
  • object
  • chargingSessionStatus
    string
      Allowed values:
    • "PENDING"
    • "ACTIVE"
    • "COMPLETED"
    • "FAULTED"
  • chargerConnectionStatus
    string
      Allowed values:
    • "ONLINE"
    • "OFFLINE"
  • connectorStatus
    string
      Allowed values:
    • "AVAILABLE"
    • "PREPARING"
    • "CHARGING"
    • "SUSPENDED_EVSE"
    • "SUSPENDED_EV"
    • "FINISHING"
    • "RESERVED"
    • "UNAVAILABLE"
    • "FAULTED"
    • "UNKNOWN"
  • chargingSessionStopReason
    string
      Allowed values:
    • "EMERGENCY_STOP"
    • "EV_DISCONNECTED"
    • "HARD_RESET"
    • "LOCAL"
    • "OTHER"
    • "POWER_LOSS"
    • "REBOOT"
    • "REMOTE"
    • "SOFT_RESET"
    • "UNLOCK_COMMAND"
    • "DE_AUTHORIZED"
  • chargingProfileConfigurationStatus
    string
      Allowed values:
    • "ACCEPTED"
    • "REJECTED"
    • "NOT_SUPPORTED"
    • "UNKNOWN"
  • chargingProfilePurpose
    string
      Allowed values:
    • "TX_DEFAULT_PROFILE"
    • "TX_PROFILE"
  • chargingProfileRequestType
    string
      Allowed values:
    • "SET_PROFILE"
    • "CLEAR_PROFILE"
  • object
  • object
  • object
  • object
  • object
  • object

    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

  • object