Share via

Managed Office Communications Server::GetPools

  • Article

This procedure retrieves a list of Office Communications Server pools.

Arguments

Input argument Required Type Description

<preferredDomainController>

Yes

xs:string

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

<pools>

A collection of pools.

<pools>/<poolFQDN>

xs:string[]

The fully qualified domain name (FQDN) of a pool.

Remarks

Security

The caller must be at least a member of role: Domain Administrator

Permission Check

This procedure will perform a test for Domain Administrator (DomainAdmin).

Business Rules

If there are no pools, an empty collection is returned.

Sequence Narrative

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

  2. The Managed Office Communications Server namespace calls Office Communcations Server Provider::GetPools.

  3. The list of pools is returned.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The domain controller to use for Active Directory actions--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Managed Office Communications Server" procedure="GetPools" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

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

Applies To

Managed Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5