v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Charge Points Sensors

Create a charge point sensor

Required scope: charge-points:write </br>Organization authorization: supported</br></br>Note: Please be aware that this endpoint is currently in the BETA phase

post/api/v1/charge-point-sensors

Request body

type'occupancy' | 'other' required

Various types of Charge Point Sensors. Definitions:

occupancy - The sensor is of type occupancy (presence). accept values for type occupancy are true, false or null

chargePointIdinteger nullable

The charge point id to which this charge point sensor is assigned to

valuestring nullable

Value this sensor is reporting, this is sensor specific, this value is managed by you

valueUpdatedAtstring date-time nullable

Indicates when the value for this sensor was last updated

externalIdstring nullable

External Id of this sensor, ideally it references the sensor id in your system

partnerExternalIdstring nullable

External Id of this entity, managed by you

Example request

{
  "type": "occupancy",
  "chargePointId": 1,
  "value": "true",
  "valueUpdatedAt": "2023-01-11T00:00:00Z",
  "externalId": "SENSOR-10005",
  "partnerExternalId": "ACME-12345"
}

Response

Charge point sensor created

idinteger

Id of this charge point sensor

type'occupancy' | 'other' required

Various types of Charge Point Sensors. Definitions:

occupancy - The sensor is of type occupancy (presence). accept values for type occupancy are true, false or null

operatorIdinteger

The operator id to which this charge point sensor is belongs to

chargePointIdinteger nullable

The charge point id to which this charge point sensor is assigned to

externalIdstring nullable

External Id of this sensor, ideally it references the sensor id in your system

partnerExternalIdstring nullable

External Id of this entity, managed by you

valuestring nullable

Value this sensor is reporting, this is sensor specific, this value is managed by you

valueUpdatedAtstring date-time nullable

Last date when charge point sensor was changed

createdAtstring date-time required

Creation date of this charge point sensor

updatedAtstring date-time required

Date this charge point sensor was last updated

deletedAtstring date-time nullable

Date this charge point sensor was deleted

Example response

{
  "id": 1,
  "type": "occupancy",
  "operatorId": 1,
  "chargePointId": 1,
  "externalId": "SENSOR-10005",
  "partnerExternalId": "ACME-12345",
  "value": "occupied",
  "valueUpdatedAt": "2022-05-12T15:56:45.91Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z",
  "deletedAt": "2022-05-12T16:56:45.99Z"
}