Skip to main content
POST
/
v3
/
chargers
/
{charger}
/
actions
/
composite-schedule
Get Composite Schedule
curl --request POST \
  --url https://app.plugchoice.com/api/v3/chargers/{charger}/actions/composite-schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_id": 123,
  "duration": 123,
  "charging_rate_unit": "<string>"
}
'
{
  "status": "<string>",
  "connectorId": 123,
  "scheduleStart": "<string>",
  "chargingSchedule": {
    "chargingRateUnit": "<string>",
    "chargingSchedulePeriod": [
      {
        "startPeriod": 123,
        "limit": 123,
        "numberPhases": 123
      }
    ],
    "duration": 123,
    "startSchedule": "<string>",
    "minChargingRate": 123
  }
}
Retrieves the composite charging schedule from the charger. The composite schedule is a merged view of all active charging profiles for a given connector and time duration.
charger
string
required
The UUID of the charger.
connector_id
integer
required
The ID of the connector to get the schedule for. Use 0 to get the schedule for the entire charge point.
duration
integer
required
The duration in seconds for the requested schedule.
charging_rate_unit
string
The unit in which the schedule should be expressed. Possible values: A (Amperes), W (Watts).

Response

status
string
The response status from the charger (Accepted or Rejected).
connectorId
integer
The connector ID for which the schedule is provided.
scheduleStart
string
The start date and time of the composite schedule (ISO 8601).
chargingSchedule
object
The composite charging schedule.