Hosted Office Communications Server::RemoveAvailablePlans

  • Article

This procedure removes service plans from the available plans list for an organization.

Use this procedure to remove Office Communications Server (OCS) user plans from the list of available plans in an organization. At least one plan must be in the list to enable users for OCS features. Removing plans from this list does not affect any users that are already assigned to the plan. It will prevent any new users in the organization from being assigned to the plan. It will also not be possible to change a user from a plan to any of the plans that have been removed.

Arguments

Input argument Required Description

<organization>

Yes

string

<preferredDomainController>

Yes

string

<availablePlans>

Yes

<availablePlans/ planName>

Yes

xs:string[]

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::SetAvailablePlanStatus, which performs a test for Reseller Administrator (OrgCreators).

Preconditions

  • The specified organization was previously subscribed to the service.

  • The specified plans were previously created.

Business Rules

The specified plans must be of type "OCSUserHosting."

Post-conditions

One or more service plans will be removed from the organization's available plan list.

Sequence Narrative

  1. Actor submits RemoveAvailablePlans 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 and allowed to have available plans for Office Communications Server.

  3. The Hosted Office Communications Server namespace calls internal private helper GetPlanWithTypeValidation_ for each plan in the available plan list. This will validate that each plan submitted in the list is of the required type "OCSUserHosting."

  4. For each plan in the list the Hosted Office Communications Server namespace calls Managed Plans::SetAvailablePlanStatus with statusTypeName='Deleted'.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--LDAP path of the customer--> 
    <organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</organization> 
    <!--FQDN of a domain controller. --> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--Defines which specific plans are available to this customer.  --> 
    <availablePlans> 
      <!--The name of the desired service plan. Can occur multiple times in the node.--> 
      <planName>OCSBasicIM</planName> 
    </availablePlans> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="RemoveAvailablePlans" impersonate="1"> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="availablePlans" 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::AddAvailablePlans