v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Schedules

Create a schedule.

Required scope: schedules:write </br>Organization authorization: supported

post/api/v1/schedules

Request body

teamIdinteger required

Id of the team that should own this schedule

namestring required

Name of the schedule

visibility'private' | 'public'

definitions:

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

timezonestring required

Timezone for interpreting the schedule entry times

priceGroupIdinteger nullable

Id of the default price group applied during scheduled windows. Defaults to the team's default price group when omitted.

selectedChargePointIdsinteger[] nullable

Ids of charge points to assign to this schedule

selectedSiteIdsinteger[] nullable

Ids of sites to assign to this schedule

Example request

{
  "teamId": 12,
  "name": "Weekday Hours",
  "timezone": "Europe/Copenhagen",
  "priceGroupId": 99,
  "selectedChargePointIds": [
    1,
    2
  ],
  "selectedSiteIds": [
    10
  ],
  "entries": [
    {
      "from": "08:00",
      "to": "18:00",
      "priceGroupId": 42
    }
  ]
}

Response

Schedule created

idinteger required

Id of the schedule

teamIdinteger required

Id of the team that owns this schedule

namestring required

Name of the schedule

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.

timezonestring required

Timezone for interpreting the schedule entry times

priceGroupIdinteger nullable

Id of the default price group applied during scheduled windows

entryCountinteger required

Number of entries in this schedule

selectedChargePointIdsinteger[] nullable

Ids of charge points directly assigned to this schedule

selectedSiteIdsinteger[] nullable

Ids of sites assigned to this schedule

createdAtstring date-time required

When the schedule was created

updatedAtstring date-time nullable

When the schedule was last updated

Example response

{
  "id": 42,
  "teamId": 12,
  "name": "Weekday Hours",
  "timezone": "Europe/Copenhagen",
  "priceGroupId": 99,
  "entryCount": 5,
  "entries": [
    {
      "id": 12,
      "from": "08:00:00",
      "to": "18:00:00",
      "priceGroupId": 42
    }
  ],
  "createdAt": "2023-03-16T15:37:23Z",
  "updatedAt": "2023-03-16T15:37:23Z"
}