Hosted Office Communications Server::GetOrganizationPlanAssignment

  • Article

This procedure retrieves the details of the Office Communications Server plan assigned to an organization.

Use this procedure to retrieve the Office Communications Server Hosted Service subscription for an organization.

Arguments

Input argument Required Type Description

<organization>

Yes

xs:string

The Lightweight directory access protocol (LDAP) path of the organization.

<preferredDomainController>

Yes

xs:string

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

<planName>

xs:string

The unique name of the plan.

<planDescription>

xs:string

The description of the plan

Remarks

Security

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

Permission Check

No explicit permission check is required for this procedure. The procedure calls Managed Plans::GetPlansByCustomer, which performs a check for Customer Administrator (UserCreators).

Preconditions

The specified organization was previously subscribed to the service.

Business Rules

None.

Post-conditions

None.

Sequence Narrative

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

  2. GetOrganizationPlanAssignment calls the GetPlanAssignment_ with the planTypeName filter equal to 'OCSOrgHosting'. An exception is thrown if the organization is not subscribed to an OCSOrgHosting plan.

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 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="GetOrganizationPlanAssignment" 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> 
    <!--The name of the plan.--> 
    <planName>OCSHosting</planName> 
    <!--The description of the service plan.--> 
    <planDescription>OCS Hosting.</planDescription> 
  </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::ChangeOrganizationPlanAssignment