• Session API

Session

post

End any ongoing session on a station and connector

This endpoint can be used to abruptly end a session on the provided station and connector.
WARNING! This action is potentially dangerous and irreversible!

chargingStationIdstring

required

The ID of the charging station

connectorIdint

required

The ID of the connector

Responses

Request examples

{
  "chargingStationId": "string",
  "connectorId": 123
}

Response examples

Session successfully aborted.

{
  "data": {
    "idempotencyId": "string",
    "id": "string",
    "networkId": "string",
    "status": "string",
    "chargingStation": {
      "id": "string",
      "networkId": "string",
      "timezone": "string",
      "powerType": "AC_1_PHASE",
      "currentSessionIds": [
        "string"
      ],
      "connectors": [
        {
          "id": 123.0,
          "maxVoltage": 123.0,
          "maxAmperage": 123.0
        }
      ]
    },
    "connectorId": 123.0,
    "rateId": "string",
    "tokenId": "string",
    "startTime": "2023-06-07T17:32:28Z",
    "meterStart": 123.0,
    "chargingStartTime": "2023-06-07T17:32:28Z",
    "endTime": "2023-06-07T17:32:28Z",
    "meterStop": 123.0,
    "detailedMeterStart": 123.0,
    "detailedMeterStop": 123.0,
    "reason": "string",
    "cost": 123.0,
    "connectorStatus": [
      {
        "timestamp": "2023-06-07T17:32:28Z",
        "errorCode": "ConnectorLockFailure",
        "status": "Available"
      }
    ],
    "correctedConnectorStatus": [
      {
        "timestamp": "2023-06-07T17:32:28Z",
        "errorCode": "ConnectorLockFailure",
        "status": "Available"
      }
    ],
    "costDetails": {
      "costs": {
        "energy": 123.0,
        "idle": 123.0,
        "flat": 123.0,
        "time": 123.0
      },
      "usages": {
        "energy": 123.0,
        "time": 123.0,
        "idle": 123.0
      }
    },
    "detailedPricingElements": [
      {
        "costs": {
          "energy": 123.0,
          "idle": 123.0,
          "flat": 123.0,
          "time": 123.0
        },
        "usages": {
          "energy": 123.0,
          "time": 123.0,
          "idle": 123.0
        },
        "components": [
          {
            "value": 123.0,
            "taxRate": 123.0,
            "billableQuantity": 123.0,
            "type": "ENERGY"
          }
        ],
        "restrictions": {
          "start_time": "string",
          "end_time": "string",
          "start_date": "string",
          "end_date": "string",
          "min_kwh": 123.0,
          "max_kwh": 123.0,
          "min_current": 123.0,
          "max_current": 123.0,
          "min_power": 123.0,
          "max_power": 123.0,
          "min_duration": 123.0,
          "max_duration": 123.0,
          "day_of_week": [
            "MONDAY"
          ]
        }
      }
    ],
    "customNote": "string",
    "autoStart": true,
    "deniedBreakdown": {
      "reason": "TIME_OUT"
    }
  }
}
post

Confirm a session was acknowledged by the station

If a session was created with autoStart set to false, this endpoint can be used to start the session.
WARNING! This action is potentially dangerous and irreversible!

acceptedboolean

required

Determines whether the session is accepted (true) or rejected (false)

Responses

Request examples

{
  "accepted": true
}

Response examples

A session has been confirmed successfully

{
  "data": {
    "idempotencyId": "string",
    "id": "string",
    "networkId": "string",
    "status": "string",
    "chargingStation": {
      "id": "string",
      "networkId": "string",
      "timezone": "string",
      "powerType": "AC_1_PHASE",
      "currentSessionIds": [
        "string"
      ],
      "connectors": [
        {
          "id": 123.0,
          "maxVoltage": 123.0,
          "maxAmperage": 123.0
        }
      ]
    },
    "connectorId": 123.0,
    "rateId": "string",
    "tokenId": "string",
    "startTime": "2023-06-07T17:32:28Z",
    "meterStart": 123.0,
    "chargingStartTime": "2023-06-07T17:32:28Z",
    "endTime": "2023-06-07T17:32:28Z",
    "meterStop": 123.0,
    "detailedMeterStart": 123.0,
    "detailedMeterStop": 123.0,
    "reason": "string",
    "cost": 123.0,
    "connectorStatus": [
      {
        "timestamp": "2023-06-07T17:32:28Z",
        "errorCode": "ConnectorLockFailure",
        "status": "Available"
      }
    ],
    "correctedConnectorStatus": [
      {
        "timestamp": "2023-06-07T17:32:28Z",
        "errorCode": "ConnectorLockFailure",
        "status": "Available"
      }
    ],
    "costDetails": {
      "costs": {
        "energy": 123.0,
        "idle": 123.0,
        "flat": 123.0,
        "time": 123.0
      },
      "usages": {
        "energy": 123.0,
        "time": 123.0,
        "idle": 123.0
      }
    },
    "detailedPricingElements": [
      {
        "costs": {
          "energy": 123.0,
          "idle": 123.0,
          "flat": 123.0,
          "time": 123.0
        },
        "usages": {
          "energy": 123.0,
          "time": 123.0,
          "idle": 123.0
        },
        "components": [
          {
            "value": 123.0,
            "taxRate": 123.0,
            "billableQuantity": 123.0,
            "type": "ENERGY"
          }
        ],
        "restrictions": {
          "start_time": "string",
          "end_time": "string",
          "start_date": "string",
          "end_date": "string",
          "min_kwh": 123.0,
          "max_kwh": 123.0,
          "min_current": 123.0,
          "max_current": 123.0,
          "min_power": 123.0,
          "max_power": 123.0,
          "min_duration": 123.0,
          "max_duration": 123.0,
          "day_of_week": [
            "MONDAY"
          ]
        }
      }
    ],
    "customNote": "string",
    "autoStart": true,
    "deniedBreakdown": {
      "reason": "TIME_OUT"
    }
  }
}
get

List all sessions

limitstring

The maximum number of sessions to return (default 20, maximum 100)

Pattern
^[0-9][0-9]?$|^100$
startingAfterstring

The ID of the last session in the previous page of results. Results will start after this session

Responses

Response examples

A list of sessions

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "idempotencyId": "string",
        "id": "string",
        "networkId": "string",
        "status": "string",
        "chargingStation": {
          "id": "string",
          "networkId": "string",
          "timezone": "string",
          "powerType": "AC_1_PHASE",
          "currentSessionIds": [
            "string"
          ],
          "connectors": [
            {
              "id": 123.0,
              "maxVoltage": 123.0,
              "maxAmperage": 123.0
            }
          ]
        },
        "connectorId": 123.0,
        "rateId": "string",
        "tokenId": "string",
        "startTime": "2023-06-07T17:32:28Z",
        "meterStart": 123.0,
        "chargingStartTime": "2023-06-07T17:32:28Z",
        "endTime": "2023-06-07T17:32:28Z",
        "meterStop": 123.0,
        "detailedMeterStart": 123.0,
        "detailedMeterStop": 123.0,
        "reason": "string",
        "cost": 123.0,
        "connectorStatus": [
          {
            "timestamp": "2023-06-07T17:32:28Z",
            "errorCode": "ConnectorLockFailure",
            "status": "Available"
          }
        ],
        "correctedConnectorStatus": [
          {
            "timestamp": "2023-06-07T17:32:28Z",
            "errorCode": "ConnectorLockFailure",
            "status": "Available"
          }
        ],
        "costDetails": {
          "costs": {
            "energy": 123.0,
            "idle": 123.0,
            "flat": 123.0,
            "time": 123.0
          },
          "usages": {
            "energy": 123.0,
            "time": 123.0,
            "idle": 123.0
          }
        },
        "detailedPricingElements": [
          {
            "costs": {
              "energy": 123.0,
              "idle": 123.0,
              "flat": 123.0,
              "time": 123.0
            },
            "usages": {
              "energy": 123.0,
              "time": 123.0,
              "idle": 123.0
            },
            "components": [
              {
                "value": 123.0,
                "taxRate": 123.0,
                "billableQuantity": 123.0,
                "type": "ENERGY"
              }
            ],
            "restrictions": {
              "start_time": "string",
              "end_time": "string",
              "start_date": "string",
              "end_date": "string",
              "min_kwh": 123.0,
              "max_kwh": 123.0,
              "min_current": 123.0,
              "max_current": 123.0,
              "min_power": 123.0,
              "max_power": 123.0,
              "min_duration": 123.0,
              "max_duration": 123.0,
              "day_of_week": [
                "MONDAY"
              ]
            }
          }
        ],
        "customNote": "string",
        "autoStart": true,
        "deniedBreakdown": {
          "reason": "TIME_OUT"
        }
      }
    ]
  }
}
post

Create a new session

This endpoint is used to request the start of a new session on a given station or to record a session that has already started. Given a duplicate request with the same charging station, connector, token, and start time, the endpoint will return the same session. If a session is already in progress on the given connector and charging station, the endpoint will not create the new session and will return an error.
WARNING! This action is potentially dangerous and irreversible!

chargingStationIdstring

required

The ID of the charging station

networkIdstring

The ID of the network associated with the session

connectorIdint

required

The ID of the connector

rateIdstring

required

The ID of the rate

tokenIdstring

required

The ID of the token

startTimestring

required

The start time of the session in date-time format

Format
date-time
meterStartnumber

required

The starting meter value

Responses

Request examples

{
  "chargingStationId": "string",
  "networkId": "string",
  "connectorId": 123,
  "rateId": "string",
  "tokenId": "string",
  "startTime": "2023-06-07T17:32:28Z",
  "meterStart": 123.0
}

Response examples

A new session has been created.

{
  "data": {
    "idempotencyId": "string",
    "id": "string",
    "networkId": "string",
    "status": "string",
    "chargingStation": {
      "id": "string",
      "networkId": "string",
      "timezone": "string",
      "powerType": "AC_1_PHASE",
      "currentSessionIds": [
        "string"
      ],
      "connectors": [
        {
          "id": 123.0,
          "maxVoltage": 123.0,
          "maxAmperage": 123.0
        }
      ]
    },
    "connectorId": 123.0,
    "rateId": "string",
    "tokenId": "string",
    "startTime": "2023-06-07T17:32:28Z",
    "meterStart": 123.0,
    "chargingStartTime": "2023-06-07T17:32:28Z",
    "endTime": "2023-06-07T17:32:28Z",
    "meterStop": 123.0,
    "detailedMeterStart": 123.0,
    "detailedMeterStop": 123.0,
    "reason": "string",
    "cost": 123.0,
    "connectorStatus": [
      {
        "timestamp": "2023-06-07T17:32:28Z",
        "errorCode": "ConnectorLockFailure",
        "status": "Available"
      }
    ],
    "correctedConnectorStatus": [
      {
        "timestamp": "2023-06-07T17:32:28Z",
        "errorCode": "ConnectorLockFailure",
        "status": "Available"
      }
    ],
    "costDetails": {
      "costs": {
        "energy": 123.0,
        "idle": 123.0,
        "flat": 123.0,
        "time": 123.0
      },
      "usages": {
        "energy": 123.0,
        "time": 123.0,
        "idle": 123.0
      }
    },
    "detailedPricingElements": [
      {
        "costs": {
          "energy": 123.0,
          "idle": 123.0,
          "flat": 123.0,
          "time": 123.0
        },
        "usages": {
          "energy": 123.0,
          "time": 123.0,
          "idle": 123.0
        },
        "components": [
          {
            "value": 123.0,
            "taxRate": 123.0,
            "billableQuantity": 123.0,
            "type": "ENERGY"
          }
        ],
        "restrictions": {
          "start_time": "string",
          "end_time": "string",
          "start_date": "string",
          "end_date": "string",
          "min_kwh": 123.0,
          "max_kwh": 123.0,
          "min_current": 123.0,
          "max_current": 123.0,
          "min_power": 123.0,
          "max_power": 123.0,
          "min_duration": 123.0,
          "max_duration": 123.0,
          "day_of_week": [
            "MONDAY"
          ]
        }
      }
    ],
    "customNote": "string",
    "autoStart": true,
    "deniedBreakdown": {
      "reason": "TIME_OUT"
    }
  }
}
post

End a session

This endpoint ends an active session by marking it as processing.
WARNING! This action is potentially dangerous and irreversible!

endTimestring

required

The end time of the session in date-time format

Format
date-time
meterStopnumber

required

The final meter value at the end of the session

detailedMeterStartnumber

The detailed starting meter value

detailedMeterStopnumber

The detailed final meter value at the end of the session

reasonstring

The reason for ending the session

networkIdstring

The ID of the network associated with the session

Responses

Request examples

{
  "endTime": "2023-06-07T17:32:28Z",
  "meterStop": 123.0,
  "detailedMeterStart": 123.0,
  "detailedMeterStop": 123.0,
  "reason": "string",
  "networkId": "string"
}

Response examples

The session has been ended

{}
post

Remote stop a session

This endpoint is used to remotely stop a session. This will emit event to ocpp to stop the session.

sessionIdstring

required

ID of the session to be remotely stopped

Responses

Response examples

No content

Empty response

post

Start a session

This endpoint is used to start a session on a given station and connector for sessions initiated with autoStart set to false. The session will be marked as ACTIVE and acknowledged as an ongoing transaction. If a session is already in progress on the given charging station and connector, the endpoint will not create the new session and will return an error.
WARNING! This action is potentially dangerous and irreversible!

meterStartint

required

Meter start value for the session

Format
int32
timestampstring

required

Timestamp for starting the session

Format
date-time

Responses

Request examples

{
  "meterStart": 123,
  "timestamp": "2023-06-07T17:32:28Z"
}

Response examples

Session started successfully

{
  "idempotencyId": "string",
  "id": "string",
  "networkId": "string",
  "status": "string",
  "chargingStation": {
    "id": "string",
    "networkId": "string",
    "timezone": "string",
    "powerType": "AC_1_PHASE",
    "currentSessionIds": [
      "string"
    ],
    "connectors": [
      {
        "id": 123.0,
        "maxVoltage": 123.0,
        "maxAmperage": 123.0
      }
    ]
  },
  "connectorId": 123.0,
  "rateId": "string",
  "tokenId": "string",
  "startTime": "2023-06-07T17:32:28Z",
  "meterStart": 123.0,
  "chargingStartTime": "2023-06-07T17:32:28Z",
  "endTime": "2023-06-07T17:32:28Z",
  "meterStop": 123.0,
  "detailedMeterStart": 123.0,
  "detailedMeterStop": 123.0,
  "reason": "string",
  "cost": 123.0,
  "connectorStatus": [
    {
      "timestamp": "2023-06-07T17:32:28Z",
      "errorCode": "ConnectorLockFailure",
      "status": "Available"
    }
  ],
  "correctedConnectorStatus": [
    {
      "timestamp": "2023-06-07T17:32:28Z",
      "errorCode": "ConnectorLockFailure",
      "status": "Available"
    }
  ],
  "costDetails": {
    "costs": {
      "energy": 123.0,
      "idle": 123.0,
      "flat": 123.0,
      "time": 123.0
    },
    "usages": {
      "energy": 123.0,
      "time": 123.0,
      "idle": 123.0
    }
  },
  "detailedPricingElements": [
    {
      "costs": {
        "energy": 123.0,
        "idle": 123.0,
        "flat": 123.0,
        "time": 123.0
      },
      "usages": {
        "energy": 123.0,
        "time": 123.0,
        "idle": 123.0
      },
      "components": [
        {
          "value": 123.0,
          "taxRate": 123.0,
          "billableQuantity": 123.0,
          "type": "ENERGY"
        }
      ],
      "restrictions": {
        "start_time": "string",
        "end_time": "string",
        "start_date": "string",
        "end_date": "string",
        "min_kwh": 123.0,
        "max_kwh": 123.0,
        "min_current": 123.0,
        "max_current": 123.0,
        "min_power": 123.0,
        "max_power": 123.0,
        "min_duration": 123.0,
        "max_duration": 123.0,
        "day_of_week": [
          "MONDAY"
        ]
      }
    }
  ],
  "customNote": "string",
  "autoStart": true,
  "deniedBreakdown": {
    "reason": "TIME_OUT"
  }
}
patch

Update a session

Updates the custom note for a specific session based on the provided session ID

customNotestring

Custom note to update for the session

networkIdstring

Network ID for the session

Responses

Request examples

{
  "customNote": "string",
  "networkId": "string"
}

Response examples

Successfully updated the session

{}

Was this page helpful?