Creating a private TOU definition requires special API permissions. Please contact us at [email protected] to find out more.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Create a private time-of-use definition for contracted rates or private tariffs.
Use this endpoint when you need a custom TOU schedule that is available only to your organization. Private TOU definitions can be used with contracted rates or private tariffs.
Creating a private TOU definition requires special API permissions. Contact [email protected] to learn more.
Resource URI
POST /rest/timeofusesRequest body
The request body maps to the TimeOfUseGroup, TimeOfUse, and Period data models. Do not specify touGroupId or touId when creating a private TOU definition. Arcadia assigns those IDs and returns them in the response.
| Field | Type | Description |
|---|---|---|
lseId | Long | LSE ID associated with the private TOU definition. Required. |
timeOfUses | Array | List of TOU definitions in the group. Required. |
timeOfUses[].touName | String | Display name for the TOU, such as Summer On-Peak. Required. |
timeOfUses[].touType | String | TOU type, such as ON_PEAK, OFF_PEAK, PARTIAL_PEAK, or CRITICAL_PEAK. Optional. |
timeOfUses[].seasonId | Long | Public season ID that limits when the TOU applies. Optional. |
timeOfUses[].calendarId | Long | Public calendar ID that affects when the TOU applies. Optional. |
timeOfUses[].touPeriods | Array | Period definitions for the TOU. Required. |
TOU period rules
Private TOU definitions must provide complete, non-overlapping coverage for the full year. Every minute must be covered by exactly one TOU period.
Days in a TOU period are evaluated individually. The fromHour and fromMinute values are inclusive, and the toHour and toMinute values are exclusive.
For the complete TOU coverage rules and a full request example, see Time of Uses.
Example
POST /rest/timeofuses{
"lseId": 100277,
"timeOfUses": [
{
"touName": "Summer On-Peak",
"calendarId": null,
"seasonId": 165,
"touType": "ON_PEAK",
"touPeriods": [
{
"fromDayOfWeek": 0,
"fromHour": 12,
"fromMinute": 0,
"toDayOfWeek": 4,
"toHour": 19,
"toMinute": 0
}
]
}
]
}A successful response returns the created private TOU group with Arcadia-assigned touGroupId and touId values.