Zum Hauptinhalt springen
POST
/
clusters
/
{clusterId}
/
schedules
Apply a schedule to every location in a cluster
curl --request POST \
  --url https://api.ridergy.com/v1/clusters/{clusterId}/schedules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "startTime": "2026-06-12T08:00:00Z",
  "endTime": "2026-06-12T18:00:00Z",
  "limitKw": 50,
  "priority": 5
}
'
{
  "clusterId": "clst_20260612_a1b2c3d4",
  "applied": [
    {
      "locationId": "3632155",
      "priority": 5,
      "limitKw": 50,
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "permanentLimitKw": 100,
      "effectiveLimitKw": 50
    }
  ],
  "errors": [
    {
      "locationId": "<string>",
      "error": {
        "error": {
          "code": "LOCATION_NOT_FOUND",
          "message": "Location 123 was not found for the provided tenant",
          "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  ],
  "totalLocations": 2
}

Autorisierungen

​
x-api-key
string
header
erforderlich

Mandanten-spezifischer API-Schlüssel. Der Mandant wird aus dem Schlüssel abgeleitet — nie aus dem Request.

Pfadparameter

​
clusterId
string
erforderlich

Body

application/json
​
startTime
string<date-time>
erforderlich

ISO-8601-UTC-Zeitstempel. Erforderlich.

Beispiel:

"2026-06-12T08:00:00Z"

​
endTime
string<date-time>
erforderlich

ISO-8601-UTC-Zeitstempel. Muss nach startTime liegen und in der Zukunft sein. Erforderlich.

Beispiel:

"2026-06-12T18:00:00Z"

​
limitKw
number<float>
erforderlich

Leistungslimit in kW. Muss größer als 0 sein. Erforderlich.

Beispiel:

50

​
priority
integer
Standard:0

Prioritätsstufe im OCPP-Stack-Stil, 0 (niedrigste) bis 10 (höchste). Wird ein Profil mit einer Priorität übermittelt, die für dieses Ziel bereits existiert, wird dieses ersetzt.

Erforderlicher Bereich: 0 <= x <= 10
Beispiel:

5

Antwort

Zeitplan auf mindestens einen Standort angewendet

​
clusterId
string
Beispiel:

"clst_20260612_a1b2c3d4"

​
applied
object[]
​
errors
object[]
​
totalLocations
integer
Beispiel:

2