schedule_mgr_list_many
Back to SOAP Architecture Method Reference
Description
The schedule_mgr_list_many method lists details of specific schedules on your domain.
Parameters
Parameter | Description | Type | Required (R) or Optional (O) |
---|---|---|---|
ids | A comma-delimited list of the unique ID#s of schedules you want to list. | string | R |
domain_id | The unique ID# of your domain. | bstypes:ResourceId | O |
Return Values
Value | Description | Type | Required (R) or Optional (O) |
---|---|---|---|
id | The unique ID# of your schedule. | bstypes:ResourceId | R |
name | The name of your schedule. | string | R |
active | Indicates whether or not the resource is in an active state. | Boolean | R |
domain_id | The unique ID# of your domain. | bstypes:ResourceId | R |
start_date | Start date of your schedule. | bstypes:SimpleDate | R |
end_date | End date of your schedule. | bstypes:SimpleDate | R |
day_of_week_mask | The bitmask value for the days of the week on which the schedule will be active. | int | R |
start_time | Start time of your schedule. | bstypes:SimpleTime | R |
end_time | End time of your schedule. | bstypes:SimpleTime | R |
reservable_id | The unique ID# of the campaign or event with which this schedule is associated. | bstypes:ResourceId | R |
weight | The default weight of the schedule. | int | R |
parent_id | The unique ID# of the schedule's loop slot. | bstypes:ResourceId | R |
schedule_group | Indicates the type of schedule group:
|
bstypes:ScheduleGroup | R |
rotation_mode | Indicates the rotation mode of the schedule:
|
bstypes:RotationMode | R |