Create a Session object

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

When a charging session starts, a Session object can be created using this call.

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

The time when the session became active.

end_datetime

date-time | null

The time when the session is completed.

kwh

double

How many kWh are charged.

auth_id

string | null

Reference to a token, identified by the auth_id field of the Token.

auth_method

string | null

Method used for authentication.

location

object

meter_id

string | null

Optional identification of the kWh meter.

currency

string | null

ISO 4217 code of the currency used for this session

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

total_cost

double | null

The total cost(excluding VAT) of the session in the
specified currency.This is the price that the eMSP
will have to pay to the CPO.A total_cost of 0.00
means free of charge. When omitted, no price
information is given in the Session object, this does
not have to mean it is free of charge.

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


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://example.com/api/ocpi/emsp/2.1.1/sessions/countryCode/partyId/sessionId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200Success