Skip to content
CleverEV Docs

Get a charging session

GET
/api/charging-sessions/{chargingSessionId}

Get /api/charging-sessions/:chargingSessionId

Parameters

Path Parameters

chargingSessionId
required
string

Request Body required

Responses

200

Response for status ok

object
success
required
boolean
chargingSession
required
object
id
required
string
transactionId
required
integer
>= -9007199254740991 <= 9007199254740991
idTag
required
string
<= 20 characters
chargerId
required
string
connectorId
required
integer
<= 9007199254740991
chargingIntentId
required
string format: uuid
userId
string
status
required
string
Allowed values: Started Stopped
startedAtTimestamp
required
string
startedAtEnergy
required
number
<= 9007199254740991
lastMeteredAtTimestamp
string
lastMeteredAtEnergy
number
<= 9007199254740991
stoppedAtTimestamp
string
stoppedAtEnergy
number
<= 9007199254740991
stoppedReason
string
Allowed values: DeAuthorized EmergencyStop EVDisconnected HardReset Local Other PowerLoss Reboot Remote SoftReset UnlockCommand
tariff
object
elements
required
Array<object>
object
id
required
string
>= 21 characters <= 21 characters
name
required
string
<= 64 characters
backgroundColor
required
string
<= 12 characters
priceComponents
required
object
Flat
string
PerMinute
string
PerKilowattHour
string
restrictions
object
startTime
object
hour
required
integer
<= 23
minute
required
integer
<= 59
endTime
object
hour
required
integer
<= 23
minute
required
integer
<= 59
daysOfWeek
Array<string>
Allowed values: Mon Tue Wed Thu Fri Sat Sun
minEnergy
number
<= 9007199254740991
maxEnergy
number
<= 9007199254740991
minCurrent
number
<= 9007199254740991
maxCurrent
number
<= 9007199254740991
minPower
number
<= 9007199254740991
maxPower
number
<= 9007199254740991
minDuration
integer
<= 9007199254740991
maxDuration
integer
<= 9007199254740991
vehicleRequestingPower
boolean
minRestrictionsDuration
integer
>= -9007199254740991 <= 9007199254740991
minPrice
string
maxPrice
string
altTexts
Array<object>
object
language
required
string
>= 2 characters <= 2 characters
text
required
string
<= 512 characters
altUrl
string format: uri
timeZone
required
string
energy
required
number
<= 9007199254740991
duration
required
number
<= 9007199254740991
price
required
string
note
string
applicationId
required
string
namespaceId
required
string
locationId
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
chargingIntent
required
object
id
required
string format: uuid
idTag
required
string
<= 20 characters
chargerId
required
string
connectorId
integer
<= 9007199254740991
chargingSessionId
string
userId
string
type
required
string
Allowed values: InApp PersonalKeycard PlugNCharge InConsole GenericKeycard InfostarKeycard InfostarRoom AutoCharge Unknown
startType
required
string
Allowed values: Remote Local
details
object
pushNotificationPreferences
object
afterEnergy
number
>= -9007199254740991 <= 9007199254740991
afterDuration
number
>= -9007199254740991 <= 9007199254740991
afterPrice
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
prioritized
boolean

403

Response for status forbidden

object
success
required
boolean
message
required
string

404

Response for status notFound

object
success
required
boolean
message
required
string

500

Response for status internalServerError

object
success
required
boolean
message
required
string