Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Installer Jobs

Update an installer job charge point

Update a charge point of an installer job. Provide exactly one of: serialNumber (optionally with connector), note, or isActive.<br>Required scope: installer-jobs:write

patch/api/v1/installer-jobs/{installerJobId}/charge-points/{chargePointId}

Path parameters

installerJobIdinteger required
chargePointIdinteger required

Request body

serialNumberstring nullable

Serial number to set on the charge point. Mutually exclusive with note and isActive.

connectorinteger nullable

Connector id to set on the charge point. Mutually exclusive with note and isActive.

notestring nullable

Operator note for the charge point. Mutually exclusive with serialNumber, connector and isActive.

isActiveboolean nullable

Activate or deactivate the charge point. Mutually exclusive with serialNumber, connector and note.

Example request

{
  "serialNumber": "SN-1234",
  "connector": 1,
  "note": "Mounted on the north wall",
  "isActive": true
}

Response

Installer job charge point updated

idinteger

Id of this installer job task

installerJobIdinteger

Id of the installer job of this installer job task

chargePointIdinteger

Id of the charge point to install

serialNumberstring nullable

Serial number of the charge point to install

connectorinteger

Connector ID of the charge point to install

notestring nullable

Note of this installer job task, will be visible to the installer

installerNotestring nullable

Note provided by installer during this installer job task

activeAtstring date-time nullable

Date this installer job task was active

createdAtstring date-time required

Creation date of this installer job task

updatedAtstring date-time nullable

Date this installer job task was last updated

deletedAtstring date-time nullable

Date this installer job task was deleted

Example response

{
  "id": 42,
  "installerJobId": 5,
  "chargePointId": 21,
  "serialNumber": "1",
  "connector": 1,
  "note": "1",
  "installerNote": "1",
  "activeAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z"
}