monitor_poll_mgr_list_by_client_resource_id

Back to SOAP Architecture Method Reference

Description

The monitor_poll_mgr_list_by_client_resource_id method lists details of specific players' or edge servers' connections to the network. For more information, see The Service Panel - Network Section.

Parameters

Parameter Description Type Required (R) or Optional (O)
client_resource_id The unique ID#s of the players or edge servers for which you want the monitor polls. bstypes:ResourceId R
domain_id The unique ID# of your domain. bstypes:ResourceId O

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of the loop policy. bstypes:ResourceId R
domain_id The unique ID# of your domain. bstypes:ResourceId R
client_resource_id The unique ID# of the player or edge server. bstypes:ResourceId R
public_ip The public IP address of the player from when it last contacted Broadsign Server. string R
private_ip The last private IP player on its LAN. string R
monitor_status The status of the resource:
  • 0 = Inactive
  • 1 = Active
  • 2 = MIA
  • 3 = Unknown
  • 4 = Retired
bstypes:ResourceMonitorStatus R
poll_last_utc The date and time when this player or edge server last polled Broadsign Server. bstypes:SimpleDateTime R
poll_next_expected_utc The date and time when this player or edge server next expects to poll Broadsign Server. bstypes:SimpleDateTime R
product_version The version # of the player or edge server. string R