This Choreo returns a particular Time of Use Group with a given touGroupId and lseId. Standard search and pagination parameters are also available. The documentation for this Genability resource can be found here.
Below is an example of acceptable inputs:
AppID: {YOUR API ID}
AppKey: {YOUR APP KEY}
LSEID: 2756
TOUGroupID: 1
The following is a sample of the JSON information returned by this Choreo:
{
"status": "success",
"count": 1,
"type": "TimeOfUseGroup",
"results": [
{
"lseId": 2756,
"touGroupId": 1,
"timeOfUses": [
{
"touId": 1,
"touGroupId": 1,
"lseId": 2756,
"touName": "Summer On-Peak",
"calendarId": null,
"isDynamic": false,
"season": {
"seasonId": 315,
"lseId": 2756,
"seasonGroupId": 3,
"seasonName": "Summer",
"seasonFromMonth": 6,
"seasonFromDay": 1,
"seasonToMonth": 9,
"seasonToDay": 30
},
"touPeriods": [
{
"touPeriodId": 1,
"touId": 1,
"fromDayOfWeek": 0,
"fromHour": 14,
"fromMinute": 0,
"toDayOfWeek": 4,
"toHour": 19,
"toMinute": 0
}
]
},
{
"touId": 2,
"touGroupId": 1,
"lseId": 2756,
"touName": "Summer Off-Peak",
"calendarId": 34,
"isDynamic": false,
"season": {
"seasonId": 315,
"lseId": 2756,
"seasonGroupId": 3,
"seasonName": "Summer",
"seasonFromMonth": 6,
"seasonFromDay": 1,
"seasonToMonth": 9,
"seasonToDay": 30
},
"touPeriods": [
{
"touPeriodId": 2,
"touId": 2,
"fromDayOfWeek": 0,
"fromHour": 19,
"fromMinute": 0,
"toDayOfWeek": 6,
"toHour": 14,
"toMinute": 0
},
{
"touPeriodId": 2037,
"touId": 2,
"fromDayOfWeek": 5,
"fromHour": 14,
"fromMinute": 0,
"toDayOfWeek": 6,
"toHour": 19,
"toMinute": 0
}
]
}
]
}
]
}