host_mgr_update
Back to SOAP Architecture Method Reference
Description
The host_mgr_update method updates the designated player or players with the provided details.
Note: Throughout this page, "host" is synonymous with "player".
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| discovery_status | The discovery status for this host:
|
bstypes:ResourceDiscoveryStatus | R |
| id | The unique ID# of the host. | bstypes:ResourceId | R |
| name | The name of this host. | string | R |
| volume | The sound volume level for this host. | int | R |
| config_profile_bag_id | The unique ID# of the configuration profile associated with this host. | bstypes:ResourceId | O |
| container_id | The ID# of the folder containing this host. | bstypes:ResourceId | O |
| db_pickup_tm_utc | The date time in UTC at which the local db for this host was sent to Broadsign Server. | bstypes:SimpleDateTime | O |
| display_unit_id | The unique ID# of the display unit attached to this host. | bstypes:ResourceId | O |
| domain_id | The unique ID# of the domain. | bstypes:ResourceId | O |
| geolocation | The geographic location in latitude and longitude for this host. | bstypes:SimplePoint | O |
| nscreens | The number of screens attached to this host. | int | O |
| remote_clear_db_tm_utc | The most recent date time in UTC at which this host local db was cleared. | bstypes:SimpleDateTime | O |
| remote_reboot_tm_utc | The most recent date time in UTC at which this host was remotely rebooted. | bstypes:SimpleDateTime | O |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of the host. | bstypes:ResourceId | R |