Charge Points Sensors

Retrieve a list of charge points sensors

GET

https://partner-api.monta.com

/api/v1/charge-point-sensors

Required scope: charge-points:read
Organization authorization: supported

Note: Please be aware that this endpoint is currently in the BETA phase

Retrieve a list of charge points sensors › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

chargePointId

integer | null · int64

Allows to filter list of charge points sensors by the charge point id

Example: 13

partnerExternalId

string | null

Filter charge points sensors by the partnerExternalId, to filter only resources without partnerExternalId use partnerExternalId=""

Example: 1

includeDeleted

boolean

Filter to include delete resources in the response

Example: true

Default: false

Retrieve a list of charge points sensors › Responses

List of charges point sensors that match the criteria

OffsetBasedResponse_15

ChargePointSensor[] · required

MontaPage.Meta · required

Create a charge point sensor

POST

https://partner-api.monta.com

/api/v1/charge-point-sensors

Required scope: charge-points:write
Organization authorization: supported

Note: Please be aware that this endpoint is currently in the BETA phase

Create a charge point sensor › Request Body

CreateChargePointSensor

type

string · enum · required

Type of the charge point sensor

Enum values:

occupancy

other

Example: occupancy

chargePointId

integer | null · int64

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

Example: 1

value

string | null

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

Example: true

valueUpdatedAt

string | null · date-time

Indicates when the value for this sensor was last updated

Example: 2023-01-11T00:00:00Z

externalId

string | null

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

Example: SENSOR-10005

partnerExternalId

string | null

External Id of this entity, managed by you

Example: ACME-12345

Create a charge point sensor › Responses

Charge point sensor created

ChargePointSensor

type

string · enum · required

Type of the charge point sensor

Enum values:

occupancy

other

Example: occupancy

createdAt

string · date-time · required

Creation date of this charge point sensor

Example: 2022-05-12T15:56:45.99Z

updatedAt

string · date-time · required

Date this charge point sensor was last updated

Example: 2022-05-12T16:56:45.99Z

id

integer · int64

Id of this charge point sensor

Example: 1

operatorId

integer · int64

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

Example: 1

chargePointId

integer | null · int64

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

Example: 1

externalId

string | null

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

Example: SENSOR-10005

partnerExternalId

string | null

External Id of this entity, managed by you

Example: ACME-12345

value

string | null

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

Example: occupied

valueUpdatedAt

string | null · date-time

Last date when charge point sensor was changed

Example: 2022-05-12T15:56:45.91Z

deletedAt

string | null · date-time

Date this charge point sensor was deleted

Example: 2022-05-12T16:56:45.99Z

POST/api/v1/charge-point-sensors

curl https://partner-api.monta.com/api/v1/charge-point-sensors \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "occupancy",
  "chargePointId": 1,
  "value": "true",
  "valueUpdatedAt": "2023-01-11T00:00:00Z",
  "externalId": "SENSOR-10005",
  "partnerExternalId": "ACME-12345"
}'

Example Request Body

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

json

Example Responses

{
  "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"
}

json

application/json

Retrieve a single charge point sensor

GET

https://partner-api.monta.com

/api/v1/charge-point-sensors/{chargePointSensorId}

Required scope: charge-points:read
Organization authorization: supported

Note: Please be aware that this endpoint is currently in the BETA phase

Retrieve a single charge point sensor › path Parameters

chargePointSensorId

integer · int64 · required

Retrieve a single charge point sensor › Responses

Charge point sensor with provided id

ChargePointSensor

type

string · enum · required

Type of the charge point sensor

Enum values:

occupancy

other

Example: occupancy

createdAt

string · date-time · required

Creation date of this charge point sensor

Example: 2022-05-12T15:56:45.99Z

updatedAt

string · date-time · required

Date this charge point sensor was last updated

Example: 2022-05-12T16:56:45.99Z

id

integer · int64

Id of this charge point sensor

Example: 1

operatorId

integer · int64

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

Example: 1

chargePointId

integer | null · int64

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

Example: 1

externalId

string | null

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

Example: SENSOR-10005

partnerExternalId

string | null

External Id of this entity, managed by you

Example: ACME-12345

value

string | null

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

Example: occupied

valueUpdatedAt

string | null · date-time

Last date when charge point sensor was changed

Example: 2022-05-12T15:56:45.91Z

deletedAt

string | null · date-time

Date this charge point sensor was deleted

Example: 2022-05-12T16:56:45.99Z

Patch an existing charge point sensor

PATCH

https://partner-api.monta.com

/api/v1/charge-point-sensors/{chargePointSensorId}

Required scope: charge-points:write
Organization authorization: supported

Note: Please be aware that this endpoint is currently in the BETA phase

Patch an existing charge point sensor › path Parameters

chargePointSensorId

integer · int64 · required

Patch an existing charge point sensor › Request Body

PatchChargePointSensor

type

string | null

Type of the charge point sensor

Example: occupancy

chargePointId

integer | null · int32

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

Example: 1

value

string | null

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

Example: true

valueUpdatedAt

string | null · date-time

Indicates when the value for this sensor was last updated

Example: 2023-01-11T00:00:00Z

externalId

string | null

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

Example: SENSOR-10005

partnerExternalId

string | null

External Id of this entity, managed by you

Example: ACME-12345

Patch an existing charge point sensor › Responses

Charge point sensor updated

ChargePointSensor

type

string · enum · required

Type of the charge point sensor

Enum values:

occupancy

other

Example: occupancy

createdAt

string · date-time · required

Creation date of this charge point sensor

Example: 2022-05-12T15:56:45.99Z

updatedAt

string · date-time · required

Date this charge point sensor was last updated

Example: 2022-05-12T16:56:45.99Z

id

integer · int64

Id of this charge point sensor

Example: 1

operatorId

integer · int64

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

Example: 1

chargePointId

integer | null · int64

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

Example: 1

externalId

string | null

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

Example: SENSOR-10005

partnerExternalId

string | null

External Id of this entity, managed by you

Example: ACME-12345

value

string | null

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

Example: occupied

valueUpdatedAt

string | null · date-time

Last date when charge point sensor was changed

Example: 2022-05-12T15:56:45.91Z

deletedAt

string | null · date-time

Date this charge point sensor was deleted

Example: 2022-05-12T16:56:45.99Z

PATCH/api/v1/charge-point-sensors/{chargePointSensorId}

curl https://partner-api.monta.com/api/v1/charge-point-sensors/:chargePointSensorId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "occupancy",
  "chargePointId": 1,
  "value": "true",
  "valueUpdatedAt": "2023-01-11T00:00:00Z",
  "externalId": "SENSOR-10005",
  "partnerExternalId": "ACME-12345"
}'

Example Request Body

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

json

Example Responses

{
  "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"
}

json

application/json

Delete an existing charge point sensor

DELETE

https://partner-api.monta.com

/api/v1/charge-point-sensors/{chargePointSensorId}

Required scope: charge-points:delete
Organization authorization: supported

Note: Please be aware that this endpoint is currently in the BETA phase

Delete an existing charge point sensor › path Parameters

chargePointSensorId

integer · int64 · required

Delete an existing charge point sensor › Responses

Charge point sensor deleted

No data returned

Charge Points Charging Rules Charges