client_registration_mgr_add

Back to SOAP Architecture Method Reference

Description

The client_registration_mgr_add method adds a player or edge server registration to 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)
domain_id The unique ID# of your domain. bstypes:ResourceId R
name The name of the player or edge server registration. string R
primary_mac_address The primary MAC address of the player or edge server. string R
target_resource_type The target resource type:
  • host = player
  • location = edge server
 string R
container_id The unique ID# of the parent folder of the registration. bstypes:ResourceId O
hostname The hostname of the player or edge server. string O
note string O
nscreens The number of screens associated with the player or edge server. unsignedInt O
public_key_fingerprint The public key fingerprint that each player or edge server receives upon registration. string O
registration_method The method used to register the player or edge server:
  • 0 = Wizard
  • 1 = CSV
  • 2 = Messenger
  • 3 = SDK
 bstypes:ClientRegistrationMethod O
replacement_resource_id The unique ID# of the player or edge server designated to replace this registration. bstypes:ResourceId O
secondary_mac_address The secondary MAC address of the player or edge server. string O
target_config_profile_bag_id The unique ID# of the configuration to which the player or edge server is assigned. bstypes:ResourceId O
target_container_id The unique ID# of the folder to which you have targeted the player or edge server. bstypes:ResourceId O
target_display_unit_id The unique ID# of the display unit to which you have targeted the player. bstypes:ResourceId O

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of the new player or edge server registration. bstypes:ResourceId R