display_unit_mgr_list
Back to SOAP Architecture Method Reference
Description
The display_unit_mgr_list method lists all display units on your domain.
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| 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 the display unit. | bstypes:ResourceId | R |
| name | The name of the display unit. | string | R |
| active |
Indicates whether the resource is in an active or inactive state. |
boolean | R |
| container_id | The unique ID# of the display unit folder. | bstypes:ResourceId | R |
| domain_id |
The unique ID# of your domain. |
bstypes:ResourceId | R |
| display_unit_type_id | The unique ID# of the display type. | bstypes:ResourceId | R |
| timezone | The time zone in which the display unit is located. | string | R |
| host_screen_count | The number of hosts (players) that are in the display unit. | int | R |
| enforce_day_parts | If toggled to "true" (that is, "on"), ensures that players in a particular display unit are online and polling during its defined day parts. | Boolean | R |
| zipcode | The zip code/postal code of the display unit. | string | R |
| address | The street address of the display unit. | string | R |
| external_id |
This field can be used to store an external identifier for the display unit in other systems. Broadsign Control Player writes the external ID in its share directory in a file named display_unit_external_id.txt. Third party applications, or HTML5/Flash content, can then read the file. |
string | R |
| enforce_screen_controls | If toggled to "true" (that is, "on"), ensures that screen controls will occur. | Boolean | R |
| geolocation | The longitude and latitude of the display unit's location. | bstypes:SimplePoint | R |
| export_enabled | Indicates whether or not the "export to non-BroadSign Players" feature is enabled. | boolean | R |
| export_first_enabled_tm | bstypes:SimpleDateTime | R | |
| export_first_enabled_by_user_id | bstypes:ResourceId | R | |
| export_retired_on_tm | bstypes:SimpleDateTime | R | |
| export_retired_by_user_id | bstypes:ResourceId | R | |
| virtual_host_screen_count | The total non-Broadsign screen count. | int | R |
| virtual_id | The unique ID# for the display unit from an external system. | string | R |
| bmb_host_id |
The unique ID# of the player resource used to fetch a |
bstypes:ResourceId | R |