date_range_mgr_list_many
Back to SOAP Architecture Method Reference
Description
The date_range_mgr_list_many method lists details of specific date ranges on your domain. A date range encapsulates days of week, as well as start and end time information, used by network controls.
Parameters
Parameter | Description | Type | Required (R) or Optional (O) |
---|---|---|---|
ids | A comma-delimited list of the unique ID#s of date ranges (network control) you want to list. | string | R |
domain_id | The unique ID# of the domain. | bstypes:ResourceId | O |
Return Values
Value | Description | Type | Required (R) or Optional (O) |
---|---|---|---|
id | The unique ID# of the date range. | bstypes:ResourceId | R |
name | The name of this date range. | string | R |
active | Whether this date range is active. | boolean | R |
domain_id | The unique ID# of the domain. | bstypes:ResourceId | R |
start_time | The start time for this date range. | bstypes:SimpleTime | R |
end_time | The end time for this date range. | bstypes:SimpleTime | R |
parent_id | The unique ID# of the parent of this date range. | bstypes:ResourceId | R |
group_id | The unique ID# of the group for this date range. | bstypes:TimeSpanGroup | R |
day_of_week_mask | The number representation of the days in which this day part is active. The value is the sum of the individual values of each day of the week, which are incrementing powers of 2, for example, Monday is 1 (2^0) and Sunday is 64 (2^6). | int | R |
start_date | The start date for this date range. | bstypes:NullableDate | R |
end_date | The end date for this date range. | bstypes:NullableDate | R |