schedule_mgr_list_scoped
Back to SOAP Architecture Method Reference
Description
The schedule_mgr_list_scoped method narrows schedule list results.
Note: Avoid confusing "scoping" as we use the term in Broadsign Control, with "scoping" as we use the term in Broadsign Control API. In Broadsign Control, "scoping" describes the limiting of what users can see (see Scoping). In Broadsign Control API, "scoping" describes the narrowing of results of certain "list" operations.
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| domain_id | The unique ID# of your domain. | bstypes:ResourceId | R |
| parent_container_ids | The unique ID# or #s of folders on your domain, used to scope your results. | 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 the resource is in an active or inactive 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 | Indicates the days of the week for which the schedule is to appear. | 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 |