Skip to main content
API docs by Redocly

pulsatrix REST API (1.0.11)

Download OpenAPI specification:Download

REST

Returns configurational data

Returns all configurational values of the charging point

Those values can only change when a new charging session is started.

Responses

Response samples

Content type
application/json
{
  • "pdName": "Daheim",
  • "ctrlrName": "Garage",
  • "sessionId": "018ba9bc-5ebe-b235-e5fb-dba94e99767e",
  • "effectiveAmperageLimit": 32,
  • "hasPhaseRotation": false,
  • "hasPhaseStShutoff": true
}

Returns transactional data

Returns all transactional values of the charging session

Those values change when session specific values change.
e.g. the car starts charging and the vehicleStatus switches B -> C

Responses

Response samples

Content type
application/json
{
  • "state": "Idle",
  • "startedTime": 1699359776,
  • "endedTime": 1699359816,
  • "meterStart": 0.302999973,
  • "meterStop": 0.302999973,
  • "vehicleStatus": "A1",
  • "chargeControllerStatus": "A",
  • "usedPhasesSession": "111",
  • "startReason": "Authorized",
  • "stopReason": "DeAuthorized",
  • "allocationSourceName": "OCPP Profile"
}

Returns charging data

Returns all charging relevant values of the charging session

Those values change constantly, whenever charging values change.
e.g. the commanded amperage increases 6A -> 14.2A

Responses

Response samples

Content type
application/json
{
  • "voltage": [
    ],
  • "amperage": [
    ],
  • "allocatedAmperage": 16,
  • "commandedAmperage": 0,
  • "availableAmperage": 18,
  • "signaledAmperage": 18,
  • "frequency": 49.930336,
  • "energyImported": 0.307999998,
  • "lastActivePower": 2036.600098
}

Updates charging relevant data

Updates charging relevant data. When setting amperageLimit and powerLimit at the same time the lower limit is used.

Request Body schema: application/json
required
enabled
boolean

Enables/disables charging

amperageLimit
number <float32> [ 0 .. 80 ]

Sets the amperage limit (a value below 6A will be set to 0A). Set to NaN to signal the SECC to take control.

powerLimit
number <float32> [ 0 .. 55200 ]

Sets the power Limit (a value below 1380W will be set to 0W) Set to NaN to signal the SECC to take control

timeout
number <int32> [ 5000 .. 86400 ]

Sets the time in ms when the data set by the API becomes invalid

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "amperageLimit": 15.5,
  • "powerLimit": 10000,
  • "timeout": 300000
}

Returns updated charging data

Returns the charging relevant data set by the api, regardless of their validity.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "amperageLimit": 15.5,
  • "powerLimit": 10000,
  • "timeout": 300000
}