Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Charge Point Integrations

Create or update a charge point integration

Note: This endpoint will create or update an existing integration,meaning that the existing integration will be replaced by a new one</br>Required scope: charge-points:write. </br>Organization authorization: supported

put/api/v1/charge-point-integrations

Request body

chargePointIdinteger required

Id of the charge point to setup the integration

chargePointModelIdinteger required

Id of the charge point model to be integrated

serialNumberstring required

The serial number for the charge point integration

connectorIdinteger nullable

Connector id for the charge point integration. when null the connectorId will default to 1

autoConnectboolean nullable

Indicates that an attempt to connect the charge point should happen, when autoConnect is set to true the Charge Point needs to point to Monta (via OCPP websocket)</br></br>Note: when false the integration will be create but the state will be to pending

ocppPasswordstring nullable

Basic authentication password that will be required for the OCPP websocket connection. Gets ignored, i.e. does not clear the password, when null

Example request

{
  "chargePointId": 13,
  "chargePointModelId": 20,
  "serialNumber": "46964534",
  "connectorId": 1,
  "autoConnect": true,
  "ocppPassword": "hunter2"
}

Response

Charge point integration created/updated

idinteger

The id of this charge point integration

state'pending' | 'connected' | 'disconnected' | 'error' | 'unknown' required

Enumerate the possible states for a charge point integration

serialNumberstring required

The serial number of this charge point integration

chargePointIdentitystring required

The identity number of this charge point integration

integrationTypeIdentifierstring required

The integration type (method) used

connectorIdinteger nullable

The connector id for this charge point integration

activeAtstring date-time nullable

The Date this charge point integration was set to active

createdAtstring date-time required

The Creation date of this charge point integration

updatedAtstring date-time nullable

The Date this charge point integration was last updated

deletedAtstring date-time nullable

The Date this charge point integration was deleted

Example response

{
  "id": 1,
  "serialNumber": "46964534",
  "chargePointIdentity": "46964534",
  "integrationTypeIdentifier": "ocpp",
  "connectorId": 1,
  "chargePoint": {
    "id": 1,
    "teamId": 1,
    "partnerExternalId": "ACME-12345",
    "siteId": 42,
    "operator": {
      "id": 14,
      "name": "Monta",
      "identifier": "monta",
      "partnerId": 1,
      "vatNumber": "FOO-123-ABC"
    },
    "createdAt": "2022-05-12T15:56:45.99Z",
    "updatedAt": "2022-05-12T16:56:45.99Z",
    "deletedAt": "2022-05-12T16:56:45.99Z",
    "activeAt": "2022-05-12T15:56:45.91Z",
    "name": "Monta CPH HQ",
    "visibility": "public",
    "maxKW": 150,
    "maxKw": 150,
    "type": "ac",
    "note": "In order to access this charge point enter 0000 as code at the gate.",
    "operatorNote": "Installer note: XYZ",
    "state": "available",
    "location": {
      "coordinates": {
        "latitude": 55.6760968,
        "longitude": 12.5683371
      },
      "addressLabel": "Strandboulevarden 122, 5. sal, 2100 København, Denmark",
      "address": {
        "address1": "Strandboulevarden 122",
        "address2": "København",
        "address3": "5. sal",
        "zip": "2100",
        "city": "Copenhagen",
        "province": "Lombardy",
        "country": "Denmark",
        "countryAreaId": 1
      }
    },
    "connectors": [
      {
        "id": 1,
        "identifier": "ccs",
        "name": "CCS"
      }
    ],
    "lastMeterReadingKwh": 913.2,
    "meterId": "2200019107351",
    "cablePluggedIn": true,
    "chargePointModelId": 42,
    "brandName": "Easee",
    "modelName": "Easee - Home",
    "firmwareVersion": "v1",
    "evseId": "DK*MON*E2",
    "priceGroupId": 42,
    "costGroupId": 42,
    "roamingPriceGroupId": 42,
    "sponsoredPriceGroupId": 42,
    "scheduleId": 42,
    "isActive": true,
    "reservable": true,
    "simCard": {
      "imsi": "310150123456789",
      "iccid": "8931501234567890123"
    },
    "roaming": true,
    "lastConnectedAt": "2023-01-18T00:00:00Z",
    "disconnectedAt": "2023-01-01T00:00:00Z",
    "occupied": true,
    "protocolData": {
      "ocpp": {
        "updatedAt": "2025-02-27T15:56:45.91Z"
      }
    },
    "metadata": {
      "busCompatible": true,
      "motorcycleCompatible": true,
      "lorryCompatible": true,
      "personalVehicleCompatible": true,
      "additionalParkingFeesPolicy": true,
      "customersOnlyPolicy": true,
      "evOnlyPolicy": true,
      "parkingOnlyWhileChargingPolicy": true,
      "floorLevel": "first",
      "cableLength": 100,
      "behindBarrierPolicy": true,
      "hdvParkingSpot": {
        "height": 400,
        "width": 300,
        "length": 600,
        "weight": 5000,
        "angledOrientation": true,
        "turningRadius": 3.5,
        "cpPosition": "null"
      },
      "dangerousGoodsAllowed": true,
      "rigidVehiclesAllowed": true,
      "vehicleAccessibility": "wheelchair_accessible",
      "overnightParkingAllowed": true,
      "accessConditions": "permit_required",
      "barrier": true,
      "trailerPullThrough": true
    },
    "smartChargeSetting": "optional",
    "userId": 42,
    "autoRegisterRfid": true
  },
  "activeAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z",
  "deletedAt": "2022-05-12T16:56:45.99Z"
}