Share via

Managed Office Communications Server::GetPoolAssignment

  • Article

This procedure retrieves the assigned Office Communication Server pool of the specified organization.

Arguments

Input argument Required Type Description

<organization>

Yes

xs:string

The Lightweight Directory Access Protocol (LDAP) path of the user.

<preferredDomainController>

Yes

xs:string

The domain controller to use for Active Directory actions.
Output argument Type Description

<poolFQDN>

xs: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 perform a test for Customer Administrator (UserCreators).

Business Rules

If there is no pool assigned, no data is returned.

Post-conditions

The assigned pool will be returned.

Sequence Narrative

  1. Actor submits GetPoolAssignment request to the Managed Office Communications Server namespace.

  2. GetPoolOWKGUID_ is called to retrieve the GUID.

  3. The OWKO is looked up using Managed Active Directory::GetOtherWellKnownObject2_

  4. Using the pool LDAP path, the FQDN of the pool is retrieved using Preferred DC Active Directory Provider::Search.

  5. The FQDN path of the pool is returned.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--LDAP path of the organization.--> 
    <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> 
  </data> 
  <procedure> 
    <execute namespace="Managed Office Communications Server" procedure="GetPoolAssignment" impersonate="1"> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--FQDN of the pool.--> 
    <poolFQDN>pool01.fabrikam.com</poolFQDN> 
  </data> 
</response>

Applies To

Managed Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5

See also

Tasks

Managed Office Communications Server::SetPoolAssignment
Managed Office Communications Server::DeletePoolAssignment