Hosted Office Communications Server::SetPoolAssignment
This parameter assigns a pool to an organization.
Use this procedure to assign an Office Communications Server pool to the specified organization. The pool will be used as the preferred pool assignment when SIP enabling users.
Arguments
Input argument | Required | Type | Description |
---|---|---|---|
<organization> |
Yes |
string |
The Lightweight Directory Access Protocol (LDAP) path of the organization. |
<preferredDomainController> |
Yes |
string |
The domain controller to use for Active Directory actions. |
<poolFQDN> |
Yes |
string |
The fully qualified domain name (FQDN) of the pool. |
Remarks
Security
The caller must be at least a member of role: Customer Administrator
Permission Check
This procedure will not perform an explicit test for Customer Administrator (UserCreators). It calls Managed Office Communications Server::SetPoolAssignment, which will perform the test.
Preconditions
The organization is subscribed to an Office Communications Server organization plan.
The pool exists.
Business Rules
None.
Post-conditions
The organization will have a reference to the application pool which will be used with CreateSipUser when HomeServerDN is not supplied.
Sequence Narrative
Actor submits SetPoolAssignment request to the Hosted Office Communications Server namespace.
SetPoolAssignment calls the GetOrganizationPlanAssignment procedure, which will retrieve the plan assigned to the organization. This validates that the organization is subscribed to the Office Communications Server service.
SetPoolAssignment calls Managed Office Communications Server::SetPoolAsssignment.
Sample Code
Example XML Request
<request>
<data>
<!--The LDAP path of the customer organization in the Service Provider domain.-->
<organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</organization>
<!--The domain controller to use for Active Directory actions.-->
<preferredDomainController>AD01.Fabrikam.Com</preferredDomainController>
<!--FQDN of the pool.-->
<poolFQDN>pool01.fabrikam.com</poolFQDN>
</data>
<procedure>
<execute namespace="Hosted Office Communications Server" procedure="SetPoolAssignment" impersonate="1">
<before source="data" sourcePath="organization" destination="executeData" mode="move" />
<before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" />
<before source="data" sourcePath="poolFQDN" destination="executeData" mode="move" />
<after source="executeData" destination="data" mode="merge" />
</execute>
</procedure>
</request>
Example XML Response
<response>
<data />
</response>
Applies To
Hosted Office Communications Server Namespace API for:
- Hosted Messaging and Collaboration version 4.5