schedule_mgr_list_by_reservable

Back to SOAP Architecture Method Reference

Description

The schedule_mgr_list_by_reservable method lists all schedules on your domain, by campaign or event.

Parameters

Parameter Description Type Required (R) or Optional (O)
id The unique ID# of the campaign or event whose schedules you want to list. string R
domain_id The unique ID# of your domain. bstypes:ResourceId R

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:
  • 1 = Channel
  • 2 = Loop slot
  • 3 = Filler
  • 4 = Program
bstypes:ScheduleGroup R
rotation_mode Indicates the rotation mode of the schedule:
  • 0 = Ordered
  • 1 = Random
bstypes:RotationMode R