Update a Session object

patch

https://example.com/api/ocpi/emsp/2.1.1/sessions/{countryCode}/{partyId}/{sessionId}

Any changes to a Session in the CPO system are sent by calling PATCH on the Sessions endpoint with the updated Session object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

countryCode

string

required

partyId

string

required

sessionId

string

required

Body Params

string | null

The unique id that identifies the session in the CPO platform

start_datetime

date-time | null

The time when the session became active.

end_datetime

date-time | null

The time when the session is completed.

kwh

double | null

How many kWh are charged.

charging_periods

array of objects | null

An optional list of charging periods that can be used to calculate and verify the total cost.

charging_periods

status

string | null

The status of the session: ACTIVE - The session is accepted and active. COMPLETED - The session is finished successfully. INVALID - The session is declared invalid and will not be billed. PENDING - The session is pending and has not yet started. This is the initial state.

last_updated

date-time

Timestamp when this Session was last updated (or created).

state_of_charge

double | null

State of Charge

Headers

Jedlix-ClientName

string

Name of the client (or system) calling the api, this is helpful for tracing requests. This is optional.

Jedlix-ClientVersion

string

Version of the client (or system) calling the api, this is helpful for tracing requests. This is optional.

Responses

400

Bad Request

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK