RetrieveSubsidiaryUsersBusinessUnit Message (CrmService)
.gif "banner art") |
[Applies to: Microsoft Dynamics CRM 4.0]
Find the latest SDK documentation: CRM 2015 SDK
| Works for all deployment types | Works online and offline |
Retrieves all user information from the child business units of the specified business unit.
The relevant classes are specified in the following table.
| Type | Class |
| Request | RetrieveSubsidiaryUsersBusinessUnitRequest |
| Response | RetrieveSubsidiaryUsersBusinessUnitResponse |
| Entity | businessunit |
Remarks
To use this message, pass an instance of the RetrieveSubsidiaryUsersBusinessUnitRequest class as the request parameter in the Execute method.
To perform this action, the caller must have access rights on the business unit entity instance. For a list of required privileges, see RetrieveSubsidiaryUsersBusinessUnit Privileges.
Example
The following code example demonstrates how to use the RetrieveSubsidiaryUsersBusinessUnit message.
[C#]
// Set up the CRM service.
CrmAuthenticationToken token = new CrmAuthenticationToken();
// You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0;
token.OrganizationName = "AdventureWorksCycle";
CrmService service = new CrmService();
service.Url = "http://<servername>:<port>/mscrmservices/2007/crmservice.asmx";
service.CrmAuthenticationTokenValue = token;
service.Credentials = System.Net.CredentialCache.DefaultCredentials;
// Create the request.
RetrieveSubsidiaryUsersBusinessUnitRequest retrieve = new RetrieveSubsidiaryUsersBusinessUnitRequest();
retrieve.EntityId = new Guid("18ECA720-493E-4800-BBFD-638BD54EB325");
retrieve.ReturnDynamicEntities = true;
// Be aware that using AllColumns may adversely affect
// performance and cause unwanted cascading in subsequent
// updates. A best practice is to retrieve the least amount of
// data required.
retrieve.ColumnSet = new AllColumns();
// Execute the request.
RetrieveSubsidiaryUsersBusinessUnitResponse retrieved = (RetrieveSubsidiaryUsersBusinessUnitResponse) service.Execute(retrieve);
[Visual Basic .NET]
' Set up the CRM service.
Dim token As New CrmAuthenticationToken()
' You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0
token.OrganizationName = "AdventureWorksCycle"
Dim service As New CrmService()
service.Url = "http://<servername>:<port>/mscrmservices/2007/crmservice.asmx"
service.CrmAuthenticationTokenValue = token
service.Credentials = System.Net.CredentialCache.DefaultCredentials
' Create the request.
Dim retrieve As New RetrieveSubsidiaryUsersBusinessUnitRequest()
retrieve.EntityId = New Guid("18ECA720-493E-4800-BBFD-638BD54EB325");
retrieve.ReturnDynamicEntities = True
' Be aware that using AllColumns may adversely affect
' performance and cause unwanted cascading in subsequent
' updates. A best practice is to retrieve the least amount of
' data required.
retrieve.ColumnSet = New AllColumns()
' Execute the request.
Dim retrieved As RetrieveSubsidiaryUsersBusinessUnitResponse = CType(service.Execute(retrieve), RetrieveSubsidiaryUsersBusinessUnitResponse)
See Also
Concepts
Reference