Hosted Office Communications Server::GetPools
This procedure gets a listing of Office Communications Server Application Pools.
Use this procedure to retrieve 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 does not need to perform an explicit permission check. The procedure calls Managed Plans::GetPools, which performs a check for Domain Administrator.
Preconditions
None.
Business Rules
If there are no pools, an empty collection is returned.
Post-conditions
A list of pools will be returned.
Sequence Narrative
Actor submits GetPools request to the Hosted Office Communications Server namespace.
GetPools calls Managed Office Communications Server::GetPools.
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="Hosted 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>
<!--The fully qualified domain name (FQDN) of a pool-->
<poolFQDN>pool01.fabrikam.com</poolFQDN>
</pools>
</data>
</response>
Applies To
Hosted Office Communications Server Namespace API for:
- Hosted Messaging and Collaboration version 4.5