Skip to main content

EVSE

Represents an Electric Vehicle Supply Equipment (EVSE) at a location. An EVSE is a physical charging station that may have one or more connectors.

capabilitiesstring[]

List of functionalities that the EVSE is capable of. Enum: CHARGING_PROFILE_CAPABLE, CREDIT_CARD_PAYABLE, REMOTE_START_STOP_CAPABLE, RESERVABLE, RFID_READER, UNLOCK_CAPABLE, CHARGING_PREFERENCES_CAPABLE, CHIP_CARD_SUPPORT, CONTACTLESS_CARD_SUPPORT, DEBIT_CARD_PAYABLE, PED_TERMINAL, START_SESSION_CONNECTOR_REQUIRED, TOKEN_GROUP_CAPABLE.

connectors Connector[]

List of available connectors on the EVSE. Each connector represents a physical charging port.

  • Array [
  • 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.

  • ]
  • coordinates Coordinates

    Represents a geographic point using decimal degrees

    latitudestring

    Latitude of the point in decimal degree. Example: 50.770774. Must have 5-7 decimal places.

    longitudestring

    Longitude of the point in decimal degree. Example: -126.104965. Must have 5-7 decimal places.

    evse_idstring

    The EVSE ID or Charge Box ID that comes from the CSMS, or is used for connecting the EVSE to the Supervisor. May be reused if a previous charger with the same EVSE ID has been removed.

    floor_levelstring

    Level on which the Charge Point is located (in garage buildings). Uses the locally displayed numbering scheme.

    images Image[]

    Images related to the EVSE such as photos or logos. Useful for visual identification of the charging station.

  • Array [
  • categorystring
    heightinteger<int64>
    thumbnailstring
    typestring
    urlstring
    widthinteger<int64>
  • ]
  • last_updatedstring

    Timestamp when this EVSE or one of its Connectors were last updated (or created). Format: RFC3339 in UTC timezone.

    parking_restrictionsstring[]

    The restrictions that apply to the parking spot. For example: EV_ONLY, PLUGGED, DISABLED, CUSTOMERS, MOTORCYCLES.

    physical_referencestring

    The string or identifier printed on the outside of the EVSE. Meant for customers to visually identify the charging station.

    uidstring

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

    protocolstring

    The Protocol used for this EVSE. Default: OMNI.

    localised_directions DisplayText[]

    Human-readable directions on how to reach the EVSE with i18n support. Helpful navigation instructions for users.

  • Array [
  • languagestring
    textstring
  • ]
  • max_vehicle_wheels_supportedinteger<int32>

    Indicates the maximum vehicle size supported by this EVSE. For example: 2 for motorcycles/scooters, 4 for cars, 6+ for trucks.

    EVSE
    {
    "capabilities": [
    "string"
    ],
    "connectors": [
    {
    "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
    }
    ],
    "coordinates": {
    "latitude": "string",
    "longitude": "string"
    },
    "evse_id": "string",
    "floor_level": "string",
    "images": [
    {
    "category": "string",
    "height": 0,
    "thumbnail": "string",
    "type": "string",
    "url": "string",
    "width": 0
    }
    ],
    "last_updated": "string",
    "parking_restrictions": [
    "string"
    ],
    "physical_reference": "string",
    "uid": "string",
    "protocol": "string",
    "localised_directions": [
    {
    "language": "string",
    "text": "string"
    }
    ],
    "max_vehicle_wheels_supported": 0
    }