Hosted Office Communications Server::GetOrganizationPlan

  • Article

This procedure retrieves the details of a specified organization plan.

Use this procedure to get the details of a specified OCSOrgHosting plan. At this time OCSOrgHosting plans do not contain any features, so there is no functional difference between OCSOrgHosting plans. It is included here to comply with the standard interface prescribed by Hosted Services.

Arguments

Input argument Required Type Description

<preferredDomainController>

Yes

xs:string

The domain controller to use for Active Directory actions.

<planName>

Yes

xs:string

The unique name of the plan
Output argument Type Description

<planName>

The unique name of the plan

<planDescription>

xs:string

The description of the plan

Remarks

Security

No restriction.

Permission Check

No explicit permission check is required for this procedure. The procedure calls Managed Plans::GetPlan, which contains no permission restriction.

Preconditions

  • The Hosted Office Communications Server namespace was initialized.

  • The specified plan was previously created.

Business Rules

The specified plan is of type 'OCSOrgHosting'.

Post-conditions

None.

Sequence Narrative

  1. Actor submits GetOrganizationPlan request to the Hosted Office Communications Server namespace.

  2. The Hosted Office Communications Server namespace calls the private procedure GetPlanWithTypeValidation_ to verify the type of the plan. This will validate that the plan submitted is of the required type "OCSOrgHosting". If not, an exception will be thrown by the called procedure.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The unique name of the service plan to be queried.--> 
    <planName>OCSHosting</planName> 
    <!--The name of the preferred domain controller in the Service Provider domain.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="GetOrganizationPlan" impersonate="1"> 
      <before source="data" sourcePath="planName" 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> 
    <!--The description of the service plan.--> 
    <planDescription>OCS Hosting.</planDescription> 
    <!--The unique name of the plan.--> 
    <planName>OCSHosting</planName> 
  </data> 
</response>

Applies To

Hosted Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5

See also

Tasks

Hosted Office Communications Server::CreateOrganizationPlan
Hosted Office Communications Server::GetOrganizationAvailablePlans
Hosted Office Communications Server::ModifyOrganizationPlan