v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Charge Points

Create a charge point

Required scope: charge-points:write </br>Organization authorization: supported

post/api/v1/charge-points

Request body

teamIdinteger required

Id of the team that the charge point belongs to

siteIdinteger required

Id of the site the charge point belongs to

chargePointModelIdinteger required

Id of the charge point model

namestring required

Name of the charge point

maxKwnumber double required

Max Kw (Max Power) the charge point can output

visibility'private' | 'public' required

definitions:

private - Indicates the charge point access is private, only available to users from operator umbrella.
public - Indicates the charge point access is public.

type'ac' | 'dc' | 'other' required

definitions:

ac - Indicates the charge point use ac (alternating current) as electric current.
dc - Indicates the charge point use ac (direct current) as electric current.
other - Indicates the team member has only access to the selected charge points.

activeboolean nullable

Indicates the charge point is active

showOnMapboolean nullable

        Indicates the charge point should be displayed on map.
        
        By setting this to false, the charge point will not be shown on the app's map, 
        but will still be fully functional for users of the charge point.

connectorIdsinteger[] nullable

       Ids of the connectors this charge point support, 
       When not present the provide charge point model connectors will be used instead.

notestring nullable

A note (instructions, warning, information) you have entered for this charge point

latitudenumber nullable

        Latitude coordinate for the charge point location.
        When provided along with longitude, overrides the site's location.

longitudenumber nullable

        Longitude coordinate for the charge point location.
        When provided along with latitude, overrides the site's location.

partnerExternalIdstring nullable

External Id of this entity, managed by you.

partnerCustomPayloadobject[] nullable

Custom JSON payload for this entity, managed by you.

smartChargeSetting'off' | 'optional' | 'forced' | 'forced-setting' nullable

        Smart charging setting for this charge point.
        - `off`: Smart charging is disabled, rules cannot be created
        - `optional`: Smart charging is optional, rules can be created and applied
        - `forced`: Smart charging is forced, rules will always be applied
        - `forced-setting`: Smart charging setting is forced

userIdinteger nullable

Id of the user that owns this charge point

Example request

{
  "teamId": 13,
  "siteId": 20,
  "chargePointModelId": 20,
  "name": "CP - CPH Office",
  "maxKw": 22,
  "active": true,
  "showOnMap": true,
  "connectorIds": [
    1,
    2,
    3,
    4
  ],
  "note": "In order to access this charge point enter 0000 as code at the gate.",
  "latitude": 55.6761,
  "longitude": 12.5683,
  "partnerExternalId": "ACME-12345",
  "smartChargeSetting": "optional",
  "userId": 42
}

Response

Charge point created