get
https://api.genability.com/rest/public/timeofuses/intervals/
Retrieve concrete date-time intervals for one time-of-use definition.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve intervals for a single time-of-use definition.
Use this endpoint to convert one touId into concrete date-time intervals for a requested period. This is useful when you need to know exactly when a specific TOU applies.
Resource URI
GET /rest/public/timeofuses/intervals/{touId}Path parameters
| Parameter | Type | Description |
|---|---|---|
touId | Long | Unique Arcadia ID for the time-of-use definition. Required. |
Query parameters
| Parameter | Type | Description |
|---|---|---|
fromDateTime | DateTime | Start date and time for returned intervals. Defaults to the current date and time when omitted. Optional. |
toDateTime | DateTime | End date and time for returned intervals. Defaults to one week after fromDateTime when omitted. Optional. |
For the full interval data model and examples, see Time of Uses.
Example
GET /rest/public/timeofuses/intervals/1?fromDateTime=2016-09-19T17:19:08-04:00&toDateTime=2016-09-19T19:00:00-04:00A successful response returns a standard response payload with type set to TimeOfUseIntervals and results containing matching intervals for the requested TOU.