Download OpenAPI specification:Download
To use this API, a client_id
and client_secret
is needed. Please contact our support to receive one for your app.
There are two kinds of endpoints: endpoints that are accessible without having an user account on the Wirelane platform, and endpoints that are accessible without. Both need a client_id and client_secret.
Retrieving a JWT access token on staging:
POST https://oauth-staging.emobilitycloud.com/token
Content-Type: application/x-www-form-urlencoded
Accept: application/json
grant_type=password&client_id=...&client_secret=...&username=...&password=...
Retrieving a JWT access token on production:
POST https://oauth.emobilitycloud.com/token
Content-Type: application/x-www-form-urlencoded
Accept: application/json
grant_type=password&client_id=...&client_secret=...&username=...&password=...
From the returned JSON, take the value of access_token
and use it in the API requests.
Retrieving a JWT access token on staging:
POST https://oauth-staging.emobilitycloud.com/token
Content-Type: application/x-www-form-urlencoded
Accept: application/json
grant_type=client_credentials&client_id=...&client_secret=...&scope=account
Retrieving a JWT access token on production:
POST https://oauth.emobilitycloud.com/token
Content-Type: application/x-www-form-urlencoded
Accept: application/json
grant_type=client_credentials&client_id=...&client_secret=...&scope=account
From the returned JSON, take the value of access_token
and use it in the API requests.
The access_token
property from the authentication request needs to be provided as authorization header to the requests:
GET https://api.wirelane.com/apis/emc/organizations/id/dewln/points?page=1&page_size=50
Accept: application/json
Authorization: Bearer $access_token
Host names for the API
Get an ordered and paginated list of members of an organization. Search query can be used to filter for members by role, status, email or creation user.
account_admin
) organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
member_status | Array of strings Items Enum: "pending" "active" "revoked" "terminated" |
order_by | string Enum: "email" "status" Name for sort |
order_direction | string Enum: "asc" "desc" "" Key for order direction |
page | integer Default: 1 Number of current page |
page_size | integer [ 1 .. 1000000 ] Default: 50 Number of items per page |
search | string Search term |
[- {
- "id": "string",
- "account": {
- "account_id": "ABCD1234",
- "tenant": "dewln",
- "email": "test@example.com",
- "invoice_email_address": "invoices@example.com",
- "first_name": "John",
- "last_name": "Doe",
- "company_name": "Wirelane GmbH",
- "vat_number": "DE999999999",
- "phone_number": "+33 4567 89",
- "address": {
- "id": 1234,
- "street": "Sample Street",
- "house_number": "12a",
- "zip_code": "80539",
- "city": "Berlin",
- "country": "DE",
- "name": "John Doe",
- "description": "Rear building"
}, - "avatar_url": "string",
- "language": "en",
- "status": "ACTIVE",
- "salutation": "Unknown",
- "terminationRequested": "2019-08-24T14:15:22Z",
- "terminationEffective": "2019-08-24T14:15:22Z",
- "terminationReason": "string",
- "billable": true,
- "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "anonymized": false,
- "blocked_reasons": [
- "UNPAID_INVOICE"
]
}, - "email": "user@example.com",
- "status": "pending"
}
]
account_admin
) accountId required | string^[a-zA-Z0-9-_]+$ Example: DEWLN-0123456789 Account ID |
organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
{- "id": "string",
- "account": {
- "account_id": "ABCD1234",
- "tenant": "dewln",
- "email": "test@example.com",
- "invoice_email_address": "invoices@example.com",
- "first_name": "John",
- "last_name": "Doe",
- "company_name": "Wirelane GmbH",
- "vat_number": "DE999999999",
- "phone_number": "+33 4567 89",
- "address": {
- "id": 1234,
- "street": "Sample Street",
- "house_number": "12a",
- "zip_code": "80539",
- "city": "Berlin",
- "country": "DE",
- "name": "John Doe",
- "description": "Rear building"
}, - "avatar_url": "string",
- "language": "en",
- "status": "ACTIVE",
- "salutation": "Unknown",
- "terminationRequested": "2019-08-24T14:15:22Z",
- "terminationEffective": "2019-08-24T14:15:22Z",
- "terminationReason": "string",
- "billable": true,
- "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "anonymized": false,
- "blocked_reasons": [
- "UNPAID_INVOICE"
]
}, - "email": "user@example.com",
- "status": "pending"
}
account_admin
) accountId required | string^[a-zA-Z0-9-_]+$ Example: DEWLN-0123456789 Account ID |
organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
[- {
- "id": "54e7c70d-fa97-11e7-b20f-00ffa96d3a77",
- "status": "ACTIVE",
- "processor": "wirelane",
- "type": "visa",
- "label": "\"**** **** **** 1234\" or \"john.doe@example.com\"",
- "metadata": [
- {
- "key": "string",
- "value": "string"
}
]
}
]
Get subscriptions for organization members
account_admin
) accountId required | string^[a-zA-Z0-9-_]+$ Example: DEWLN-0123456789 Account ID |
organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
{- "id": "3073b46e-1e17-4d9d-8485-1ebd9424f6b7",
- "upcoming_subscription": {
- "plan": {
- "id": 1,
- "plan_key": "wirelane_public_ac_01",
- "name": "Wirelane Large",
- "amount": 100,
- "currency": "EUR",
- "interval_type": "SECONDS",
- "interval_count": 1,
- "properties": {
- "seats": 5
}, - "plan_group": "PUBLIC",
- "default_tax_rate": 19,
- "tax_rate_invoice_text": [
- {
- "language": "de",
- "text": "string"
}
], - "seat_active_min": 3,
- "amount_seat_order": 1200,
- "amount_seat_recurrent": 1200,
- "activation_date": "2015-11-25T10:43:02+0100",
- "deactivation_date": "2017-10-25T06:55:44+0200",
- "termination_date": "2027-07-25T00:00:00+0200",
- "service_levels": [
- {
- "id": 1,
- "key": "dewln_ac_01",
- "title": "Tariff for wirelane ac charging",
- "description": "0,39 € per kWh + 0,03 € per Minute",
- "tariff": "DEWLN_AC_01"
}
], - "unlock_code": "-Y0u_;et_@_d!$,Ou*t.",
- "subscription_count": 0
}, - "quantity": 0,
- "tax_rate": 0
}, - "current_period": {
- "plan": {
- "id": 1,
- "plan_key": "wirelane_public_ac_01",
- "name": "Wirelane Large",
- "amount": 100,
- "currency": "EUR",
- "interval_type": "SECONDS",
- "interval_count": 1,
- "properties": {
- "seats": 5
}, - "plan_group": "PUBLIC",
- "default_tax_rate": 19,
- "tax_rate_invoice_text": [
- {
- "language": "de",
- "text": "string"
}
], - "seat_active_min": 3,
- "amount_seat_order": 1200,
- "amount_seat_recurrent": 1200,
- "activation_date": "2015-11-25T10:43:02+0100",
- "deactivation_date": "2017-10-25T06:55:44+0200",
- "termination_date": "2027-07-25T00:00:00+0200",
- "service_levels": [
- {
- "id": 1,
- "key": "dewln_ac_01",
- "title": "Tariff for wirelane ac charging",
- "description": "0,39 € per kWh + 0,03 € per Minute",
- "tariff": "DEWLN_AC_01"
}
], - "unlock_code": "-Y0u_;et_@_d!$,Ou*t.",
- "subscription_count": 0
}, - "currency": "EUR",
- "amount": 0,
- "uid": "3073b46e-1e17-4d9d-8485-1ebd9424f6b7",
- "begin": "2015-11-25T10:43:02+0100",
- "end": "2015-11-25T10:43:02+0100",
- "quantity": 1,
- "tax_rate": 19
}, - "plan_key": "WIRELANE-ABO-ANNUEL-3",
- "begin": "2015-11-25T10:43:02+0100",
- "end": "2015-11-25T10:43:02+0100",
- "account_id": "ABCD1234"
}
Finding charging points for the account.
account_admin
) organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
auth_type | Array of strings Items Enum: "card" "remote" "direct" "" The charging station authorization type.
|
charging_station_id | Array of strings Filter by list of charging station id's |
charging_type | Array of strings Items Enum: "AC" "DC" "" The charging type.
|
distance | string^[0-9]*$ Search distance in meters |
evseid | Array of strings Filter by list of evseids |
infrastructure_only | string^[0-1]{1}$ To exchange only infrastructure specific data |
lat | string^[-+]?[0-9]*.?[0-9]+$ Latitude |
lon | string^[-+]?[0-9]*.?[0-9]+$ Longitude |
max_power | string^[-+]?[0-9]*.?[0-9]+$ The charging speed. Greater than 0 |
north_east_lat | string^[-+]?[0-9]*.?[0-9]+$ Latitude |
north_east_lon | string^[-+]?[0-9]*.?[0-9]+$ Longitude |
not_in_point_groups | Array of strings |
order_by | string Enum: "evseid" "status" "latitude" "longitude" "power" "voltage" "chargingType" "plugType" "country" "city" "zipCode" "creationDate" "updateDate" "distance" Name for sort |
order_direction | string Enum: "asc" "desc" "" Key for order direction |
owner_id | Array of strings Filter by list of owner_id |
page | integer Default: 1 Number of current page |
page_size | integer [ 1 .. 1000000 ] Default: 50 Number of items per page |
plug_types | Array of strings Items Enum: "TYPE_1" "TYPE_1_ATCH" "TYPE_2" "TYPE_2_ATCH" "TYPE_3" "TYPE_3_ATCH" "CHADEMO" "CCS" "SCHUKO" "UNKNOWN" "" The plug types.
|
point_groups | Array of strings Search for specific point groups |
reservable | string^[0-1]{1}$ To exchange only reservable points |
search | string Search term |
sort_lat | string^[-+]?[0-9]*.?[0-9]+$ Latitude for sortable |
sort_lon | string^[-+]?[0-9]*.?[0-9]+$ Longitude for sortable |
south_west_lat | string^[-+]?[0-9]*.?[0-9]+$ Latitude |
south_west_lon | string^[-+]?[0-9]*.?[0-9]+$ Longitude |
status | Array of strings Status of the points. If one point in the station hits the requested status the entire station is returned.
|
[- {
- "id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charging_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charging_station_id": "98fd4f3a554f33c12eca9b5e2e4b369a",
- "charge_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "evseid": "DESGDE000801",
- "display_id": "RED_LEFT",
- "owner": "WIRELANE-2500781",
- "emp": "desgd",
- "cpo": "desgd",
- "plug_types": [
- "TYPE_2",
- "SCHUKO"
], - "charging_type": "AC",
- "model": "string",
- "serial_number": "string",
- "current": 0,
- "power": 22,
- "voltage": 230,
- "reservable": true,
- "authentication_types": [
- "card",
- "remote",
- "nfc_terminal",
- "direct"
], - "status": "FREE",
- "country": "DE",
- "city": "Schwäbisch Gmünd",
- "zip_code": "73525",
- "street": "Honiggasse",
- "house_number": "21",
- "opening_hours": "Mo-Fr 09:00 - 20:00",
- "availability": {
- "label": "Mon-Fr 08:00-22:00, Sat-Sun CLOSED",
- "open247": false,
- "monday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "tuesday": [
- [
- "0000",
- "0000"
]
], - "wednesday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "thursday": [
- [
- "0000",
- "0000"
]
], - "friday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "1645"
], - [
- "1800",
- "0000"
]
], - "saturday": [
- [
- "0000",
- "0000"
]
], - "sunday": [ ],
- "exceptionalOpenings": {
- "Thu Dec 24 2020 00:00:00 GMT+0000 (Coordinated Universal Time)": [
- [
- "0000",
- "0900"
], - [
- "0930",
- "1300"
]
], - "*-12-25": [ ],
- "*-12-26": [ ]
}
}, - "timezone": "Europe/Berlin",
- "service_hotline": 800557788,
- "longitude": 9.79944,
- "latitude": 48.8026,
- "distance": 1002.23,
- "creation_date": "2019-08-24T14:15:22Z",
- "update_date": "2019-08-24T14:15:22Z",
- "charging_provider": "emc",
- "charging_group": [
- {
- "id": 1,
- "name": "AC Chargers",
- "owner": "WIRELANE-2500781"
}
]
}
]
Create a charging point for the provider of the organization.
account_admin
) organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
Create a charging point
charge_point_id required | string The technical ID of the charge point connector. Shown to the user, and could be printed on the label (label code) |
authentication_types | Array of strings Items Enum: "card" "remote" "nfc_terminal" "direct" Authentication method for the charging point |
object Availability of charging point | |
Array of objects (ChargingPointGroup) | |
charging_station_id | string An optional user-defined ID to group different charging points into one logical station. Used for grouping in some apps. |
charging_type | string Enum: "AC" "DC" Electricity type (AC or DC) |
city | string |
country | string In ISO 3166-1 alpha-2 |
cpo | string Name of the Charge Point Operator |
current | integer Current in Ampere |
display_id | string |
distance | number <float> Is returned when searching for charging points and providing a center |
emp | string Name of the Emobility provider. [Deprecated] |
evseid | string The EVSE ID used for roaming. |
house_number | string |
latitude | number <float> Latitude of the charging point (WGS 84) |
longitude | number <float> Longitude of the charging point (WGS 84) |
model | string Name of the charge point model |
opening_hours | string @deprecated - use availability instead. Label describing charging point availability. |
owner | string The owner of the charging station. |
payment_url | string |
plug_types | Array of strings Items Enum: "TYPE_1" "TYPE_1_ATCH" "TYPE_2" "TYPE_2_ATCH" "TYPE_3" "TYPE_3_ATCH" "CHADEMO" "CCS" "SCHUKO" "UNKNOWN" Up to four types of plugs. |
power | number <double> Power in kWh |
reservable | boolean If this charging point supports reservations |
serial_number | string The serial number |
service_hotline | string The telephone number of the service hotline |
status | string Enum: "FREE" "IN_USE" "UNAVAILABLE" "UNKNOWN" "FAULTED" "RESERVED" "CLOSED" Status of the points. If one point in the station hits the requested status the entire station is returned. (Comma Separated List)
|
street | string |
timezone | string Timezone of charging point. |
voltage | integer Voltage in V |
zip_code | string |
{- "charging_station_id": "98fd4f3a554f33c12eca9b5e2e4b369a",
- "charge_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "evseid": "DESGDE000801",
- "display_id": "RED_LEFT",
- "owner": "WIRELANE-2500781",
- "emp": "desgd",
- "cpo": "desgd",
- "plug_types": [
- "TYPE_2",
- "SCHUKO"
], - "charging_type": "AC",
- "model": "string",
- "serial_number": "string",
- "current": 0,
- "power": 22,
- "voltage": 230,
- "reservable": true,
- "authentication_types": [
- "card",
- "remote",
- "nfc_terminal",
- "direct"
], - "status": "FREE",
- "country": "DE",
- "city": "Schwäbisch Gmünd",
- "zip_code": "73525",
- "street": "Honiggasse",
- "house_number": "21",
- "opening_hours": "Mo-Fr 09:00 - 20:00",
- "availability": {
- "label": "Mon-Fr 08:00-22:00, Sat-Sun CLOSED",
- "open247": false,
- "monday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "tuesday": [
- [
- "0000",
- "0000"
]
], - "wednesday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "thursday": [
- [
- "0000",
- "0000"
]
], - "friday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "1645"
], - [
- "1800",
- "0000"
]
], - "saturday": [
- [
- "0000",
- "0000"
]
], - "sunday": [ ],
- "exceptionalOpenings": {
- "Thu Dec 24 2020 00:00:00 GMT+0000 (Coordinated Universal Time)": [
- [
- "0000",
- "0900"
], - [
- "0930",
- "1300"
]
], - "*-12-25": [ ],
- "*-12-26": [ ]
}
}, - "timezone": "Europe/Berlin",
- "service_hotline": 800557788,
- "longitude": 9.79944,
- "latitude": 48.8026,
- "distance": 1002.23,
- "charging_group": [
- {
- "id": 1,
- "name": "AC Chargers",
- "owner": "WIRELANE-2500781"
}
]
}
{- "id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charging_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charging_station_id": "98fd4f3a554f33c12eca9b5e2e4b369a",
- "charge_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "evseid": "DESGDE000801",
- "display_id": "RED_LEFT",
- "owner": "WIRELANE-2500781",
- "emp": "desgd",
- "cpo": "desgd",
- "plug_types": [
- "TYPE_2",
- "SCHUKO"
], - "charging_type": "AC",
- "model": "string",
- "serial_number": "string",
- "current": 0,
- "power": 22,
- "voltage": 230,
- "reservable": true,
- "authentication_types": [
- "card",
- "remote",
- "nfc_terminal",
- "direct"
], - "status": "FREE",
- "country": "DE",
- "city": "Schwäbisch Gmünd",
- "zip_code": "73525",
- "street": "Honiggasse",
- "house_number": "21",
- "opening_hours": "Mo-Fr 09:00 - 20:00",
- "availability": {
- "label": "Mon-Fr 08:00-22:00, Sat-Sun CLOSED",
- "open247": false,
- "monday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "tuesday": [
- [
- "0000",
- "0000"
]
], - "wednesday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "thursday": [
- [
- "0000",
- "0000"
]
], - "friday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "1645"
], - [
- "1800",
- "0000"
]
], - "saturday": [
- [
- "0000",
- "0000"
]
], - "sunday": [ ],
- "exceptionalOpenings": {
- "Thu Dec 24 2020 00:00:00 GMT+0000 (Coordinated Universal Time)": [
- [
- "0000",
- "0900"
], - [
- "0930",
- "1300"
]
], - "*-12-25": [ ],
- "*-12-26": [ ]
}
}, - "timezone": "Europe/Berlin",
- "service_hotline": 800557788,
- "longitude": 9.79944,
- "latitude": 48.8026,
- "distance": 1002.23,
- "creation_date": "2019-08-24T14:15:22Z",
- "update_date": "2019-08-24T14:15:22Z",
- "charging_provider": "emc",
- "charging_group": [
- {
- "id": 1,
- "name": "AC Chargers",
- "owner": "WIRELANE-2500781"
}
]
}
Get a single charging point by their charging point evseId
account_admin
) organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
pointId required | string^[a-zA-Z0-9-_*]+$ The ID to search for. Note that not all characters indicated by the pattern are allowed for each type of ID; e.g., the asterisk is only allowed if an EVSE ID is provided. |
pointTypeId required | string^[a-zA-Z0-9-_]+$ Enum: "id" "evseid" "charging_point_id" "charge_point_id" Sets which field of ChargingPoint the
|
{- "id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charging_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charging_station_id": "98fd4f3a554f33c12eca9b5e2e4b369a",
- "charge_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "evseid": "DESGDE000801",
- "display_id": "RED_LEFT",
- "owner": "WIRELANE-2500781",
- "emp": "desgd",
- "cpo": "desgd",
- "plug_types": [
- "TYPE_2",
- "SCHUKO"
], - "charging_type": "AC",
- "model": "string",
- "serial_number": "string",
- "current": 0,
- "power": 22,
- "voltage": 230,
- "reservable": true,
- "authentication_types": [
- "card",
- "remote",
- "nfc_terminal",
- "direct"
], - "status": "FREE",
- "country": "DE",
- "city": "Schwäbisch Gmünd",
- "zip_code": "73525",
- "street": "Honiggasse",
- "house_number": "21",
- "opening_hours": "Mo-Fr 09:00 - 20:00",
- "availability": {
- "label": "Mon-Fr 08:00-22:00, Sat-Sun CLOSED",
- "open247": false,
- "monday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "tuesday": [
- [
- "0000",
- "0000"
]
], - "wednesday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "thursday": [
- [
- "0000",
- "0000"
]
], - "friday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "1645"
], - [
- "1800",
- "0000"
]
], - "saturday": [
- [
- "0000",
- "0000"
]
], - "sunday": [ ],
- "exceptionalOpenings": {
- "Thu Dec 24 2020 00:00:00 GMT+0000 (Coordinated Universal Time)": [
- [
- "0000",
- "0900"
], - [
- "0930",
- "1300"
]
], - "*-12-25": [ ],
- "*-12-26": [ ]
}
}, - "timezone": "Europe/Berlin",
- "service_hotline": 800557788,
- "longitude": 9.79944,
- "latitude": 48.8026,
- "distance": 1002.23,
- "creation_date": "2019-08-24T14:15:22Z",
- "update_date": "2019-08-24T14:15:22Z",
- "charging_provider": "emc",
- "charging_group": [
- {
- "id": 1,
- "name": "AC Chargers",
- "owner": "WIRELANE-2500781"
}
]
}
Update a charging point for the provider of the organization.
account_admin
) organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
pointId required | string^[a-zA-Z0-9-_*]+$ The ID to search for. Note that not all characters indicated by the pattern are allowed for each type of ID; e.g., the asterisk is only allowed if an EVSE ID is provided. |
pointTypeId required | string^[a-zA-Z0-9-_]+$ Enum: "id" "evseid" "charging_point_id" "charge_point_id" Sets which field of ChargingPoint the
|
Create a charging point
charge_point_id required | string The technical ID of the charge point connector. Shown to the user, and could be printed on the label (label code) |
authentication_types | Array of strings Items Enum: "card" "remote" "nfc_terminal" "direct" Authentication method for the charging point |
object Availability of charging point | |
Array of objects (ChargingPointGroup) | |
charging_station_id | string An optional user-defined ID to group different charging points into one logical station. Used for grouping in some apps. |
charging_type | string Enum: "AC" "DC" Electricity type (AC or DC) |
city | string |
country | string In ISO 3166-1 alpha-2 |
cpo | string Name of the Charge Point Operator |
current | integer Current in Ampere |
display_id | string |
distance | number <float> Is returned when searching for charging points and providing a center |
emp | string Name of the Emobility provider. [Deprecated] |
evseid | string The EVSE ID used for roaming. |
house_number | string |
latitude | number <float> Latitude of the charging point (WGS 84) |
longitude | number <float> Longitude of the charging point (WGS 84) |
model | string Name of the charge point model |
opening_hours | string @deprecated - use availability instead. Label describing charging point availability. |
owner | string The owner of the charging station. |
payment_url | string |
plug_types | Array of strings Items Enum: "TYPE_1" "TYPE_1_ATCH" "TYPE_2" "TYPE_2_ATCH" "TYPE_3" "TYPE_3_ATCH" "CHADEMO" "CCS" "SCHUKO" "UNKNOWN" Up to four types of plugs. |
power | number <double> Power in kWh |
reservable | boolean If this charging point supports reservations |
serial_number | string The serial number |
service_hotline | string The telephone number of the service hotline |
status | string Enum: "FREE" "IN_USE" "UNAVAILABLE" "UNKNOWN" "FAULTED" "RESERVED" "CLOSED" Status of the points. If one point in the station hits the requested status the entire station is returned. (Comma Separated List)
|
street | string |
timezone | string Timezone of charging point. |
voltage | integer Voltage in V |
zip_code | string |
{- "charging_station_id": "98fd4f3a554f33c12eca9b5e2e4b369a",
- "charge_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "evseid": "DESGDE000801",
- "display_id": "RED_LEFT",
- "owner": "WIRELANE-2500781",
- "emp": "desgd",
- "cpo": "desgd",
- "plug_types": [
- "TYPE_2",
- "SCHUKO"
], - "charging_type": "AC",
- "model": "string",
- "serial_number": "string",
- "current": 0,
- "power": 22,
- "voltage": 230,
- "reservable": true,
- "authentication_types": [
- "card",
- "remote",
- "nfc_terminal",
- "direct"
], - "status": "FREE",
- "country": "DE",
- "city": "Schwäbisch Gmünd",
- "zip_code": "73525",
- "street": "Honiggasse",
- "house_number": "21",
- "opening_hours": "Mo-Fr 09:00 - 20:00",
- "availability": {
- "label": "Mon-Fr 08:00-22:00, Sat-Sun CLOSED",
- "open247": false,
- "monday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "tuesday": [
- [
- "0000",
- "0000"
]
], - "wednesday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "thursday": [
- [
- "0000",
- "0000"
]
], - "friday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "1645"
], - [
- "1800",
- "0000"
]
], - "saturday": [
- [
- "0000",
- "0000"
]
], - "sunday": [ ],
- "exceptionalOpenings": {
- "Thu Dec 24 2020 00:00:00 GMT+0000 (Coordinated Universal Time)": [
- [
- "0000",
- "0900"
], - [
- "0930",
- "1300"
]
], - "*-12-25": [ ],
- "*-12-26": [ ]
}
}, - "timezone": "Europe/Berlin",
- "service_hotline": 800557788,
- "longitude": 9.79944,
- "latitude": 48.8026,
- "distance": 1002.23,
- "charging_group": [
- {
- "id": 1,
- "name": "AC Chargers",
- "owner": "WIRELANE-2500781"
}
]
}
{- "id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charging_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charging_station_id": "98fd4f3a554f33c12eca9b5e2e4b369a",
- "charge_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "evseid": "DESGDE000801",
- "display_id": "RED_LEFT",
- "owner": "WIRELANE-2500781",
- "emp": "desgd",
- "cpo": "desgd",
- "plug_types": [
- "TYPE_2",
- "SCHUKO"
], - "charging_type": "AC",
- "model": "string",
- "serial_number": "string",
- "current": 0,
- "power": 22,
- "voltage": 230,
- "reservable": true,
- "authentication_types": [
- "card",
- "remote",
- "nfc_terminal",
- "direct"
], - "status": "FREE",
- "country": "DE",
- "city": "Schwäbisch Gmünd",
- "zip_code": "73525",
- "street": "Honiggasse",
- "house_number": "21",
- "opening_hours": "Mo-Fr 09:00 - 20:00",
- "availability": {
- "label": "Mon-Fr 08:00-22:00, Sat-Sun CLOSED",
- "open247": false,
- "monday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "tuesday": [
- [
- "0000",
- "0000"
]
], - "wednesday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "0000"
]
], - "thursday": [
- [
- "0000",
- "0000"
]
], - "friday": [
- [
- "0900",
- "1230"
], - [
- "1330",
- "1645"
], - [
- "1800",
- "0000"
]
], - "saturday": [
- [
- "0000",
- "0000"
]
], - "sunday": [ ],
- "exceptionalOpenings": {
- "Thu Dec 24 2020 00:00:00 GMT+0000 (Coordinated Universal Time)": [
- [
- "0000",
- "0900"
], - [
- "0930",
- "1300"
]
], - "*-12-25": [ ],
- "*-12-26": [ ]
}
}, - "timezone": "Europe/Berlin",
- "service_hotline": 800557788,
- "longitude": 9.79944,
- "latitude": 48.8026,
- "distance": 1002.23,
- "creation_date": "2019-08-24T14:15:22Z",
- "update_date": "2019-08-24T14:15:22Z",
- "charging_provider": "emc",
- "charging_group": [
- {
- "id": 1,
- "name": "AC Chargers",
- "owner": "WIRELANE-2500781"
}
]
}
Get charging sessions conducted on the organization infrastructure
account_admin
) organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
charge_point_id | Array of strings Filter by list of charge_point_id |
charging_point_id | string^[a-zA-Z0-9-_*+]+$ Charging Point ID |
date_picker_since | string <date-time> ^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{... The date time to search from |
date_picker_until | string <date-time> ^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{... The date time to search to |
order_by | string Enum: "sessionId" "emp" "ownerId" "chargingStationId" "pointScmId" "evseid" "status" "sessionBegin" "sessionEnd" "tariff" "price" "kwh" "chargingSessionType" "chargingType" "plugType" "country" "city" "zipCode" "creationDate" "updateDate" Name for sort |
order_direction | string Enum: "asc" "desc" "" Key for order direction |
organization_type | Array of strings Items Enum: "emp" "cpo" "owner" "" Type of the organization |
owner_id | Array of strings Filter by list of owner_id |
page | integer Default: 1 Number of current page |
page_size | integer [ 1 .. 1000000 ] Default: 50 Number of items per page |
search | string Search term |
status | Array of strings The charging session status to search for:
|
[- {
- "session_id": "string",
- "cpo_session_id": "19eea288-1ee1-5aa9-b258-38fea1df55f3",
- "customer_id": "WIRELANE-7900915",
- "customer_email": "customer@example.com",
- "customer_membership_owner": "wirelane",
- "card_number": "WIRELANE123456",
- "card_short_reference": "CarXYZ",
- "language": "de",
- "charging_station_id": "98fd4f3a554f33c12eca9b5e2e4b369a",
- "charging_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charge_point_id": "DESGDE000801-2",
- "evseid": "DESGDE000801",
- "owner": "WIRELANE-2500781",
- "emp": "desgd",
- "cpo": "eclearing",
- "charging_provider": "wirelane",
- "plug_type": "TYPE_2",
- "charging_type": "AC",
- "country": "DE",
- "city": "Schwäbisch Gmünd",
- "zip_code": 73525,
- "street": "Honiggasse",
- "house_number": 21,
- "tariff": "LADEPAY_01",
- "tariff_text": "string",
- "price_model": "desgd_ladepay_01",
- "price_model_text": "string",
- "identification": "e6f252d6-30a0-5416-8533-126335a2ad2d",
- "identification_type": "access_token",
- "cpo_created": true,
- "process_begin": "2017-10-15T16:44:45+0200",
- "process_end": "2017-10-15T17:53:04+0200",
- "transaction_begin": "2017-10-15T16:44:40+0200",
- "transaction_end": "2017-10-15T17:52:59+0200",
- "session_begin": "2017-10-15T16:44:40+0200",
- "session_end": "2017-10-15T17:52:59+0200",
- "transaction_duration": 68,
- "session_duration": 68,
- "kwh": 17.46,
- "has_signed_value": true,
- "price": 1.7,
- "tax_rate": 0.19,
- "currency": "EUR",
- "charging_session_type": "comfort_charging",
- "status": "closed",
- "charging_state": "charging",
- "creation_date": "2017-10-15T16:44:40+0200",
- "update_date": "2017-10-15T17:53:04+0200",
- "meter_start": 1541678196,
- "meter_stop": 1541678196,
- "error_code": "emc_timeout",
- "error_message": "Manually closed because of time out"
}
]
Get a single charging session conducted on the organization infrastructure
account_admin
) organizationId required | string^[a-zA-Z0-9-_]+$ Example: DEMOTENANT Organization ID |
sessionId required | string^[a-zA-Z0-9-_]+$ The ID to search for |
{- "session_id": "string",
- "cpo_session_id": "19eea288-1ee1-5aa9-b258-38fea1df55f3",
- "customer_id": "WIRELANE-7900915",
- "customer_email": "customer@example.com",
- "customer_membership_owner": "wirelane",
- "card_number": "WIRELANE123456",
- "card_short_reference": "CarXYZ",
- "language": "de",
- "charging_station_id": "98fd4f3a554f33c12eca9b5e2e4b369a",
- "charging_point_id": "00eb08a9b45c69a4f9f14982a0095e12",
- "charge_point_id": "DESGDE000801-2",
- "evseid": "DESGDE000801",
- "owner": "WIRELANE-2500781",
- "emp": "desgd",
- "cpo": "eclearing",
- "charging_provider": "wirelane",
- "plug_type": "TYPE_2",
- "charging_type": "AC",
- "country": "DE",
- "city": "Schwäbisch Gmünd",
- "zip_code": 73525,
- "street": "Honiggasse",
- "house_number": 21,
- "tariff": "LADEPAY_01",
- "tariff_text": "string",
- "price_model": "desgd_ladepay_01",
- "price_model_text": "string",
- "identification": "e6f252d6-30a0-5416-8533-126335a2ad2d",
- "identification_type": "access_token",
- "cpo_created": true,
- "process_begin": "2017-10-15T16:44:45+0200",
- "process_end": "2017-10-15T17:53:04+0200",
- "transaction_begin": "2017-10-15T16:44:40+0200",
- "transaction_end": "2017-10-15T17:52:59+0200",
- "session_begin": "2017-10-15T16:44:40+0200",
- "session_end": "2017-10-15T17:52:59+0200",
- "transaction_duration": 68,
- "session_duration": 68,
- "kwh": 17.46,
- "has_signed_value": true,
- "price": 1.7,
- "tax_rate": 0.19,
- "currency": "EUR",
- "charging_session_type": "comfort_charging",
- "status": "closed",
- "charging_state": "charging",
- "creation_date": "2017-10-15T16:44:40+0200",
- "update_date": "2017-10-15T17:53:04+0200",
- "meter_start": 1541678196,
- "meter_stop": 1541678196,
- "error_code": "emc_timeout",
- "error_message": "Manually closed because of time out"
}
account_admin
)