Skip to main content

Connector

Represents a physical charging connector (cable or socket) on an EVSE

formatstring

The format (socket/cable) of the installed connector. Enum: SOCKET, CABLE.

uidstring

Unique identifier for the connector, which should never be changed or modified. For example, the database ID.

connector_idstring

CPO's identifier for the connector. Usually meant to be human readable.

last_updatedstring

Timestamp when this connector was last updated (or created). Format: RFC3339 in UTC timezone.

max_amperageinteger<int32>

Maximum amperage of the connector, in ampere [A]. Used for calculating charging power and compatibility.

max_electric_powerinteger<int32>

Maximum electric power that can be delivered by this connector, in Watts (W). Calculated from voltage and amperage.

max_voltageinteger<int32>

Maximum voltage of the connector (line to neutral for AC_3_PHASE), in volt [V]. Common values: 230V (AC), 400V (DC).

power_typestring

Type of power available at this connector. Enum: AC_1_PHASE, AC_2_PHASE, AC_2_PHASE_SPLIT, AC_3_PHASE, DC.

standardstring

The standard of the installed connector. Enum: CHADEMO, IEC_60309_2_single_16, IEC_60309_2_three_16, IEC_60309_2_three_32, IEC_60309_2_three_64, IEC_62196_T1, IEC_62196_T1_COMBO, IEC_62196_T2, IEC_62196_T2_COMBO, IEC_62196_T3A, IEC_62196_T3C, TESLA_R, TESLA_S.

tariff_uidsstring[]

Identifiers of the currently valid charging tariffs. Multiple tariffs are possible, but only one of each Tariff.type can be active at the same time. For a "free of charge" tariff, this field should be set and point to a defined "free of charge" tariff.

terms_and_conditionsstring

Terms of use, contractual agreements, and conditions that govern the usage of the connector. May include URLs to full terms documents.

statusstring

Indicates the current status of the connector. Enum: AVAILABLE, PREPARING, CHARGING, FINISHING, INOPERATIVE, OUTOFORDER, PLANNED, REMOVED, RESERVED, UNKNOWN.

reliabilitynumber<float>

The consistency and dependability of the connector over time. Range: 0.0 to 10.0, where 10.0 is most reliable.

uptimenumber<float>

The amount of time the connector is operational and available for charging sessions. Range: 0.0 to 1.0, where 1.0 is 100% uptime.

qr_identifierstring

String that is usually printed as a QR code or as a short label. Used to navigate to the charger on the UI, either through a QR scanner or by being keyed in.

privilege_statusstring

Indicates access restrictions for this connector. Enum: PUBLIC, PRIVATE, RESTRICTED.

onlineboolean

Whether the charger is online. Not supported by all CPOs. If it is unsupported, it will be null.

physical_referencestring

Human readable string identifying the charger gun. Usually a short name such as "Gun A" or "Connector 1".

is_enabledboolean

Determines whether this connector can be used for charging. Disabled connectors cannot start new sessions.

is_publishedboolean

Determines whether this connector should be shown on the UI. Unpublished connectors are hidden from public views.

is_transient_web_enabledboolean

Determines whether this connector supports transient web payments. For example: Guest Checkout, Pay-as-you-go, etc.

Connector
{
  "format": "string",
  "uid": "string",
  "connector_id": "string",
  "last_updated": "string",
  "max_amperage": 0,
  "max_electric_power": 0,
  "max_voltage": 0,
  "power_type": "string",
  "standard": "string",
  "tariff_uids": [
    "string"
  ],
  "terms_and_conditions": "string",
  "status": "string",
  "reliability": 0,
  "uptime": 0,
  "qr_identifier": "string",
  "privilege_status": "string",
  "online": true,
  "physical_reference": "string",
  "is_enabled": true,
  "is_published": true,
  "is_transient_web_enabled": true
}