Hosted Office Communications Server::ModifyOrganizationPlan

  • Article

This precedure modifies an organization OCSOrgHosting plan.

Use this procedure to modify an existing OCSOrgHosting plan. At this time OCSOrgHosting plans do not contain any features, so there is no functional difference between OCSOrgHosting plans. This procedure offers little value add over the generic Managed Plans::ModifyPlan procedure but 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.

<newPlanName>

No

xs:string

The new unique name of the plan.

<planDescription>

No

xs:string

The description of the plan.

Remarks

Security

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

Permission Check

No explicit permission check is required for this procedure. The procedure calls Managed Plans::ModifyPlan, which performs a test for Domain Administrator.

Preconditions

  • The Hosted Office Communications Server namespace was initialized.

  • The plan was previously created.

Business Rules

The specified plan must be of type 'OCSOrgHosting'.

Post-conditions

The plan will be updated with the specified values.

Sequence Narrative

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

  2. The Hosted Office Communications Server namespace calls the private procedure GetPlanWithTypeValidation_ to validate the type of the plan.

  3. The Hosted Office Communications Server namespace calls the Managed Plans::ModifyPlan procedure.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The name of the preferred domain controller in the Service Provider domain.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--The unique name of the new service plan to be assigned to the customer.--> 
    <planName>OCSHosting</planName> 
    <!--New unique name for the plan--> 
    <newPlanName>PremiumOCSHosting</newPlanName> 
    <!--Description of the plan--> 
    <planDescription>Premium OCS Services</planDescription> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="ModifyOrganizationPlan" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="planName" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="newPlanName" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="planDescription" 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::CreateOrganizationPlan
Hosted Office Communications Server::GetOrganizationPlan
Hosted Office Communications Server::GetOrganizationAvailablePlans