Hosted Office Communications Server::ChangeUserPlanAssignment

  • Article

This procedure changes the plan assigned to an organization by specifying a new plan.

Use this procedure to change the Office Communications Server Plan assignment from one OCSOrgHosting plan to another. At this time OCSOrgHosting plans do not contain any features, so there is no functional difference between OCSOrgHosting plans.

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.

<planName>

Yes

xs:string

The OCS Hosting plan for the organization.

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::ChangeCustomerPlan, which in performs a test for Customer Administrator (UserCreators).

Preconditions

  • The specified organization was previously subscribed to the service.

  • The specified plan was previously created.

Business Rules

The specified plan must be of type "OCSOrgHosting."

Post-conditions

The specified plan will be assigned to the organization.

Sequence Narrative

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

  2. The Hosted Office Communications Server namespace calls the GetOrganizationPlanAssignment procedure, which will retrieve the plan assigned to the organization. This validates that the organization is subscribed to the Office Communications Server service.

  3. The Hosted Office Communications Server namespace calls internal private helper GetPlanWithTypeValidation_ for the specified plan. This will validate that the plan submitted is of the required type "OCSOrgHosting."

  4. The Hosted Office Communications Server namespace calls Managed Plans::ChangeCustomerPlan.

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> 
    <!--The OCS Hosting Plan to apply to the organization.--> 
    <planName>OCSHosting</planName> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="ChangeOrganizationPlanAssignment" impersonate="1"> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="planName" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
        <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::Initialize