skin_mgr_list_scoped
Back to SOAP Architecture Method Reference
Description
The skin_mgr_list_scoped method narrows frame 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.
Note: In Broadsign Control Administrator, "scoping" describes the limiting of what users can see (see Scoping). In BroadSign Open, "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 frame. | bstypes:ResourceId | R |
| name | The name of your frame. | 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 |
| loop_policy_id | The unique ID# of the affiliated loop policy. | bstypes:ResourceId | R |
| x | The x-coordinate of the frame, in relation to the full screen. | int | R |
| y | The y-coordinate of the frame, in relation to the full screen. | int | R |
| z | The z-coordinate of the frame, in relation to the full screen. | int | R |
| width | The width of the frame, according to geometry type. | int | R |
| height | The height of the frame, according to geometry type. | int | R |
| screen_no | The number of screens. | int | R |
| geometry_type | The frame's geometry type:
|
bstypes:GeometryType | R |
| parent_id | The unique ID# of the day part to which the frame is associated. | bstypes:ResourceId | R |
| interactivity_trigger_id | The unique ID# of the trigger associated with the frame. | bstypes:ResourceId | R |
| interactivity_timeout | Duration in milliseconds of the timeout of an interactive action during the playback of the associated campaign. | int | R |