LocationWithDistance
Wraps a location with its distance from a search point
location Location
Represents a charging location with one or more EVSEs
Unique identifier for the location, which should never be changed or modified. For example, the database ID.
Block number and street name. The street address of the charging location.
Indicates if the EVSEs still allow charging after opening hours. E.g. if the barriers for a parking lot are closed, are vehicles allowed to charge until the next morning? Default: true.
City or town. The city where the charging location is situated.
coordinates Coordinates
Represents a geographic point using decimal degrees
Latitude of the point in decimal degree. Example: 50.770774. Must have 5-7 decimal places.
Longitude of the point in decimal degree. Example: -126.104965. Must have 5-7 decimal places.
ISO-3166 alpha-2 code for the country of this location. For example: "SG", "MY", "US".
ISO-3166 alpha-2 country code of the CPO that 'owns' this Location. May differ from country if CPO operates internationally.
evses EVSE[]
List of EVSEs that belong to this Location. Each EVSE represents a physical charging station.
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.
The format (socket/cable) of the installed connector. Enum: SOCKET, CABLE.
Unique identifier for the connector, which should never be changed or modified. For example, the database ID.
CPO's identifier for the connector. Usually meant to be human readable.
Timestamp when this connector was last updated (or created). Format: RFC3339 in UTC timezone.
Maximum amperage of the connector, in ampere [A]. Used for calculating charging power and compatibility.
Maximum electric power that can be delivered by this connector, in Watts (W). Calculated from voltage and amperage.
Maximum voltage of the connector (line to neutral for AC_3_PHASE), in volt [V]. Common values: 230V (AC), 400V (DC).
Type of power available at this connector. Enum: AC_1_PHASE, AC_2_PHASE, AC_2_PHASE_SPLIT, AC_3_PHASE, DC.
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.
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 of use, contractual agreements, and conditions that govern the usage of the connector. May include URLs to full terms documents.
Indicates the current status of the connector. Enum: AVAILABLE, PREPARING, CHARGING, FINISHING, INOPERATIVE, OUTOFORDER, PLANNED, REMOVED, RESERVED, UNKNOWN.
The consistency and dependability of the connector over time. Range: 0.0 to 10.0, where 10.0 is most reliable.
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.
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.
Indicates access restrictions for this connector. Enum: PUBLIC, PRIVATE, RESTRICTED.
Whether the charger is online. Not supported by all CPOs. If it is unsupported, it will be null.
Human readable string identifying the charger gun. Usually a short name such as "Gun A" or "Connector 1".
Determines whether this connector can be used for charging. Disabled connectors cannot start new sessions.
Determines whether this connector should be shown on the UI. Unpublished connectors are hidden from public views.
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
Latitude of the point in decimal degree. Example: 50.770774. Must have 5-7 decimal places.
Longitude of the point in decimal degree. Example: -126.104965. Must have 5-7 decimal places.
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.
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.
Timestamp when this EVSE or one of its Connectors were last updated (or created). Format: RFC3339 in UTC timezone.
The restrictions that apply to the parking spot. For example: EV_ONLY, PLUGGED, DISABLED, CUSTOMERS, MOTORCYCLES.
The string or identifier printed on the outside of the EVSE. Meant for customers to visually identify the charging station.
Unique identifier for the EVSE, which should never be changed or modified. For example, the database ID.
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.
Indicates the maximum vehicle size supported by this EVSE. For example: 2 for motorcycles/scooters, 4 for cars, 6+ for trucks.
Optional list of facilities that this location belongs to. For example: HOTEL, RESTAURANT, CAFE, MALL.
images Image[]
Images related to the location such as photos or logos. Can include location photos, operator logos, etc.
Timestamp when this Location or one of its EVSEs or Connectors were last updated (or created). Format: RFC3339 in UTC timezone.
Display name of the location. Human-readable name shown to users.
opening_times OpeningTimes
Defines when the EVSEs at the location can be accessed for charging
exceptional_closings ExceptionalClosings[]
List of exceptional periods when the location is closed. For example, holidays or maintenance periods.
Timestamp of beginning of the exceptional closing period. Format: RFC3339 in UTC timezone.
Timestamp of end of the exceptional closing period. Format: RFC3339 in UTC timezone.
exceptional_openings ExceptionalOpenings[]
List of exceptional periods when the location is open outside regular hours. For example, special events or extended hours.
Timestamp of beginning of the exceptional opening period. Format: RFC3339 in UTC timezone.
Timestamp of end of the exceptional opening period. Format: RFC3339 in UTC timezone.
regular_hours RegularHours[]
Regular hours when the location is accessible during normal weeks. Defines the standard operating schedule.
operator BusinessDetails
suboperator BusinessDetails
owner BusinessDetails
The general type of parking at the charge point location. Enum: ALONG_MOTORWAY, PARKING_GARAGE, PARKING_LOT, ON_DRIVEWAY, ON_STREET, UNDERGROUND_GARAGE.
Postal code of the location. May be omitted when the location has no postal code (e.g., highway locations in some countries).
related_locations AdditionalGeoLocation[]
Geographical location of related points relevant to the user. For example, entrances, elevators, or other access points.
name DisplayText
Latitude of the point in decimal degree. Example: 50.770774.
Longitude of the point in decimal degree. Example: -126.104965.
State or province of the location. Only used when relevant for the country.
One of IANA tzdata TZ-values representing the time zone of the location. Examples: Europe/Oslo, Europe/Zurich, Asia/Singapore.
Defines if a Location is published on OMNI. Unpublished locations are hidden from public views.
ID of the CPO that 'owns' this Location. Used for filtering and access control.
localised_directions DisplayText[]
Human-readable directions on how to reach the location with i18n support. Helpful navigation instructions for users.
Distance in meters from the search center point. Used for sorting and display.
{
"location": {
"uid": "string",
"address": "string",
"charging_when_closed": true,
"city": "string",
"coordinates": {
"latitude": "string",
"longitude": "string"
},
"country": "string",
"country_code": "string",
"evses": [
{
"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
}
],
"facilities": [
"string"
],
"images": [
{
"category": "string",
"height": 0,
"thumbnail": "string",
"type": "string",
"url": "string",
"width": 0
}
],
"last_updated": "string",
"name": "string",
"opening_times": {
"exceptional_closings": [
{
"period_begin": "string",
"period_end": "string"
}
],
"exceptional_openings": [
{
"period_begin": "string",
"period_end": "string"
}
],
"regular_hours": [
{
"period_begin": "string",
"period_end": "string",
"weekday": 0
}
]
},
"operator": {
"name": "string",
"website": "string",
"logo": "string"
},
"suboperator": {
"name": "string",
"website": "string",
"logo": "string"
},
"owner": {
"name": "string",
"website": "string",
"logo": "string"
},
"parking_type": "string",
"postal_code": "string",
"related_locations": [
{
"name": {
"language": "string",
"text": "string"
},
"latitude": "string",
"longitude": "string"
}
],
"state": "string",
"time_zone": "string",
"publish": true,
"entity_code": "string",
"localised_directions": [
{
"language": "string",
"text": "string"
}
]
},
"distance_meters": 0
}