client_registration_mgr_list_many

Back to SOAP Architecture Method Reference

Description

The client_registration_mgr_list_many method lists details of specific player and edge serverregistrations 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 or edge servers you want to list. string 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 player or edge server registration. bstypes:ResourceId R
name The name of the player or edge server registration. string R
active Indicates whether or not the resource is active. boolean R
container_id The unique ID# of the player or edge server's parent folder. bstypes:ResourceId R
domain_id The unique ID# of your domain. bstypes:ResourceId R
primary_mac_address The primary MAC address of the player or edge server. string R
secondary_mac_address The secondary MAC address of the player or edge server. string R
public_key_fingerprint The public key fingerprint that each player or edge server receives upon registration. string R
replacement_resource_id The unique ID# of the player or edge server designated to replace this registration. bstypes:ResourceId R
registration_method The method used to register the player or edge server:
  • 0 = Wizard
  • 1 = CSV
  • 2 = Messenger
  • 3 = SDK
bstypes:ClientRegistrationMethod R
discovery_tm_utc Indicates the date/time at which the player or edge server polled Broadsign Server. bstypes:SimpleDateTime R
claimed_resource_id Indicates the unique ID# that the player or edge server will receive upon registration. bstypes:ResourceId R
target_resource_type The target resource type:
  • host = player
  • location = edge server
string R
target_container_id The unique ID# of the folder to which you have targeted the player or edge server. bstypes:ResourceId R
target_display_unit_id The unique ID# of the display unit to which you have targeted the player. bstypes:ResourceId R
target_config_profile_bag_id The unique ID# of the configuration to which the player or edge server is assigned. bstypes:ResourceId R
promoted_by_resource_id The unique ID# of the resource that promoted the registration. bstypes:ResourceId R
licensed Indicates whether or not BroadSign has licensed the player or edge server. int R
nscreens The number of screens associated with the player or edge server. unsignedInt R
hostname The hostname of the player or edge server. string R