host_mgr_list_many
Back to SOAP Architecture Method Reference
Description
The host_mgr_list_many method lists details of specific players on your domain.
Note: Edge servers and players are unique resources in Broadsign Control in that they are both products (Broadsign Control Player and Broadsign Control Edge Server) and resources (player and edge server). As a convention, once you register one of these products, we no longer refer to it by product name, but by resource name.
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| ids | A comma-delimited list of the unique ID#s of players you want to list. | string | R |
| domain_id | The unique ID# of the domain. | bstypes:ResourceId | O |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of the player. | bstypes:ResourceId | R |
| name | The name of this player. | string | R |
| active | Indicates whether or not the resource is active. | boolean | R |
| container_id | The ID# of the folder containing the player. | bstypes:ResourceId | R |
| domain_id | The unique ID# of the domain. | bstypes:ResourceId | R |
| primary_mac_address | The primary MAC address of the player. | string | R |
| secondary_mac_address | The secondary MAC address of the player. | string | R |
| discovery_status | The discovery status for the player:
|
bstypes:ResourceDiscoveryStatus | R |
| licensed | Indicates whether or not the resource is licensed. | boolean | R |
| license_end_date | The date at which the license expires for this player. | bstypes:SimpleDate | R |
| config_profile_bag_id | The unique ID# of the configuration profile associated with this player. | bstypes:ResourceId | R |
| db_pickup_tm_utc | The date time in UTC at which the local db for this player was sent to Broadsign Server. | bstypes:SimpleDateTime | R |
| public_key_fingerprint | The public key fingerprint for this player. | string | R |
| remote_reboot_tm_utc | The most recent date time in UTC at which this player was remotely rebooted. | bstypes:SimpleDateTime | R |
| remote_clear_db_tm_utc | The most recent date time in UTC at which this player local db was cleared. | bstypes:SimpleDateTime | R |
| display_unit_id | The unique ID# of the display unit associated to this player. | bstypes:ResourceId | R |
| nscreens | The number of screens attached to this player. | int | R |
| volume | The sound volume level for this player. | int | R |
| geolocation | The geographic location in latitude and longitude for this player. | bstypes:SimplePoint | R |