Overview

Charger Status API#

The Charger Status API allows you to obtain the following information.

Charger availability status: charger is Available, Unavailable, and Faulted.
Connector availability status: connector is Available, Unavailable, and so on. For the different connector availability statuses, see Charger Status API Reference.
Charger connectivity status: charger is connected or not connected.

API Usage#

See Token Management API for more information on how to create and use the access token.

Charger Availability Status#

Prepare Request Body#

To prepare a request body, perform the following steps.

Set charger ID to the request path parameter chargerId. See Charger Status API Reference.

Example Request#

Note

Use the server URL applicable to your region. See [API Reference](./charger_status_api_reference.md) for available server URLs applicable to your region.

export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>

export CHARGER_ID = <YOUR_CHARGER_ID>

curl --location --request GET 'https://api.eu.depot.emobility.io/v1/chargerStatus/chargers/$CHARGER_ID/availabilityStatus' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN'

Response Body#

Successful response returns 200 HTTP status code with response body as ChargerAvailabilityStatusList schema. For more information, see Charger Status API Reference.

Example Response#

{
  "items": [
    {
      "timeStamp": "2022-10-18T08:37:44.210Z",
      "errorCode": "NoError",
      "vendorErrorCode": 1,
      "vendorId": 23,
      "status": "Available"
    }
  ]
}

Connector Availability Status#

Prepare Request Body#

To prepare a request body, perform the following steps.

Set charger ID to the request path parameter chargerId.
Set connector ID to the request path parameter connectorId. See Charger Status API Reference.

Example Request#

Note

Use the server URL applicable to your region. See [API Reference](./charger_status_api_reference.md) for available server URLs applicable to your region.

export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>

export CHARGER_ID = <YOUR_CHARGER_ID>
export CONNECTOR_ID = <YOUR_CONNECTOR_ID>

curl --location --request GET 'https://api.eu.depot.emobility.io/v1/chargerStatus/chargers/$CHARGER_ID/connectors/$CONNECTOR_ID/availabilityStatus' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN'

Response Body#

Successful response returns 200 HTTP status code with response body as ChargerAvailabilityStatusList schema. For more information, see Charger Status API Reference.

Example Response#

{
  "items": [
    {
      "timeStamp": "2022-10-18T08:37:44.210Z",
      "errorCode": "NoError",
      "vendorErrorCode": 23,
      "vendorId": 1,
      "status": "Available"
    }
  ]
}

Charger Connectivity Status#

Prepare Request Body#

To prepare a request body, perform the following steps.

Set charger ID to the request path parameter chargerId. See Charger Status API Reference.

Example Request#

Note

Use the server URL applicable to your region. See [API Reference](./charger_status_api_reference.md) for available server URLs applicable to your region.

export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>

export CHARGER_ID = <YOUR_CHARGER_ID>

curl --location --request GET 'https://api.eu.depot.emobility.io/v1/chargerStatus/chargers/$CHARGER_ID/connectivityStatus' \
--header 'Accept: application/json'
--header 'Authorization: Bearer $ACCESS_TOKEN'

Response Body#

Successful response returns 200 HTTP status code with response body as ChargerConnectivityStatusList schema. For more information, see Charger Status API Reference.

Example Response#

{
  "items": [
    {
      "time": "2022-08-18T05:23:04.334Z",
      "value": "true"
    }
  ]
}