The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
Skip to content
DepotFinity

DepotFinity is a cloud-based software service that is used to monitor, report, schedule and manage the charging operations of chargers within a depot.

Session Reports API¶

Session Report API allows you to read the session report information of HPC chargers with legacy CCBox in raw format. The query response contains an array of session report objects. To limit the query results for a selected time period or number of result items, use from, to, page, and limit parameters in your request body.

API Usage¶

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

Session Reports¶

Prepare Request Body¶

Set the following query parameters to prepare the request body.

  1. Charger ID to chargerId.
  2. Connector ID to connectorId.
  3. Additional query parameter for filtering the response. For more information, see Session Reports API Reference.

Example Request¶

Note

Use the server URL applicable to your region. See API Reference 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/sessionReports?chargerId=$CHARGER_ID&connectorId=$CONNECTOR_ID'
  --header 'Authorization: Bearer $ACCESS_TOKEN'

Response Body¶

Successful response returns 200 HTTP status code with response body as SessionReports schema. For more information, see Session Reports API Reference.

Example Response¶

{
    "items": [
        {
            "sessionId": 123456789,
            "vehicleId": "qwerty",
            "ocppStatus": [
                {
                    "value": "Available",
                    "eventTimestamp": "2021-03-23T16:54:56.087Z"
                },
                {
                    "value": "Preparing",
                    "eventTimestamp": "2021-03-23T16:59:11.670Z"
                },
                ...
            ],
            "detailStatus": [
                {
                    "key": "systemStatus",
                    "value": "0x00000000",
                    "eventTimestamp": "2021-03-23T00:48:26.437Z"
                },
                {
                    "key": "operationalStatus",
                    "value": "0x00000000",
                    "eventTimestamp": "2021-03-23T00:48:26.437Z"
                },
                ...
            ],
            "deviceStatus": [
                {
                    "status": "OPEN",
                    "deviceId": "Breaker",
                    "eventTimestamp": "2021-03-23T16:52:33.173Z"
                },
                {
                    "status": "STANDBY",
                    "deviceId": "Converter",
                    "errorCodes": [
                        {
                            "errorCode": "WARN: converter : sibcos 1: VQS disabled from operating mode(no:144)",
                            "errorCounter": 29
                        },
                        ...
                    ],
                    "eventTimestamp": "2021-03-23T16:55:11.088Z"
                }
            ],
            "energySocEnd": 98,
            "energySocStart": 76,
            "sessionTimeEnd": "2022-08-03T16:40:30.440Z",
            "energyChargeEnd": 1046400,
            "chargeParameters": [
                {
                    "maxPower": 450000,
                    "paramType": "Station",
                    "maxCurrent": 600,
                    "maxVoltage": 750,
                    "minCurrent": 0,
                    "minVoltage": 400,
                    "eventTimestamp": "2021-03-23T16:59:12.052Z"
                },
                {
                    "maxPower": 600000,
                    "paramType": "Request",
                    "maxCurrent": 800,
                    "maxVoltage": 750,
                    "minCurrent": 0,
                    "minVoltage": 0,
                    "eventTimestamp": "2021-03-23T16:59:12.186Z"
                },
                ...
            ],
            "energyPrimaryEnd": 293138710,
            "sessionTimeStart": "2022-08-03T16:20:30.661Z",
            "energyChargeStart": 1009136,
            "energyPrimaryStart": 293099449,
            "energyRequestedEnd": 1054122,
            "sessionMeterValues": [
                {
                    "key": "present_current",
                    "value": 0,
                    "eventTimestamp": "2021-03-23T16:54:35.287Z"
                },
                {
                    "key": "present_voltage",
                    "value": 3,
                    "eventTimestamp": "2021-03-23T16:59:08.685Z"
                },
                ...
            ],
            "energyRequestedStart": 1016608,
            "batteryAlignmentResults": {
                "inRange": true,
                "eventTimestamp": "2021-03-23T16:59:38.672Z",
                "presentVoltage": 633,
                "requestedVoltage": 633
            },
            "dcBreakerOpenConditions": {
                "current": 0,
                "voltage": 676,
                "eventTimestamp": "2021-03-23T17:13:44.735Z"
            }
        }
    ],
    "ChargerID": "xyz",
    "ConnectorID": "1"
}