relationship_mgr_list_many
Back to SOAP Architecture Method Reference
Description
The relationship_mgr_list_many method lists details of specific relationship resources on your domain. A relationship is an association between an upgrade channel and a player or an edge server. It could also be an association between a media package and a display unit.
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 relationships 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 your relationship. | bstypes:ResourceId | R |
| active | Indicates whether the resource is in an active or inactive state. | boolean | R |
| domain_id | The unique ID# of your relationship. | bstypes:ResourceId | R |
| parent_id | The unique ID# of either an upgrade channel or a media package. | bstypes:ResourceId | R |
| right_resource_id | The unique ID# of either a player, an edge server or a display unit. | bstypes:ResourceId | R |