Start a charging session

POST

https://api.ocpplab.io/evcharger/commands/start-session

POST

/evcharger/commands/start-session

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.evcharger.commands.startSession({
        target: {
            deployment_id: "vd-cp-fast-201",
        },
        payload: {
            id_tag: "TAG-RFID-001",
        },
    });
}
main();

{
  "targeted_count": 2,
  "queued_count": 2,
  "failed_count": 0,
  "results": [
    {
      "charger_id": "dep-123",
      "identity": "CP-TEST-001",
      "command": {
        "id": "a1b2c3d4e5f6",
        "event_type": "start_transaction",
        "ocpp_version": "ocpp1.6",
        "payload": {
          "id_tag": "TAG-RFID-001",
          "evse_id": 1,
          "connector_id": 1
        }
      }
    }
  ],
  "failed": []
}

Run a full charging session start on the targeted virtual chargers: plug in, authorize the id tag, then start the transaction. Returns 202 once the command is queued. Each results[].command.id is a command id: poll GET /evcharger/commands/{command_id} (client.evcharger.commands.get_status(command_id)) until its status is final. It answers 404 until the charger has received the command.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

targetobjectRequired

Command target resolved in the service layer under the caller organization.

payloadobjectRequired

High-level simulator session start payload.

Response

Command queued for the targeted chargers

targeted_countinteger

queued_countinteger

failed_countinteger

resultslist of objects

failedlist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error