Hosted Office Communications Server::GetOrganizationAvailablePlans

This procedure returns a listing of service plans that are available for the users of an organization.

Use this procedure to retrieve a listing of available OCSUserHosting plans for a specified organization.

Arguments

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::GetAvailablePlansByCustomer, which performs a test for User Creators.

Preconditions

The organization exists in Active Directory and is a valid customer record in the Plan Manager database.

Business Rules

None.

Post-conditions

None.

Sequence Narrative

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

2. The Hosted OCS Namespace calls the GetOrganizationPlanAssignment procedure to check the organization has been subscribed to an Office Communications Server service.

3. The Hosted Office Communications Server namespace calls the Managed Plans::GetAvailablePlansByCustomer procedure to retrieve a list of all available plans assigned to the organization.

4. An after transform is used to extract only those plans from the list that are of type 'OCSUserHosting'.

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> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="GetOrganizationAvailablePlans" 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 collection of available service plans for this customer--> 
    <availablePlans> 
      <!--Container element for service plan details--> 
      <plan> 
        <!--The name of the desired service plan.--> 
        <planName>IM</planName> 
        <!--Description of plan--> 
        <planDescription>Presence</planDescription> 
        <!--The status of this service plan--> 
        <planStatus>Enabled</planStatus> 
        <!--The date the service plan was created--> 
        <dateCreated>2008-04-01T01:28:59.510000000</dateCreated> 
        <!--The last date the service plan record was updated--> 
        <dateLastUpdated>2008-04-01T01:29:07.560000000</dateLastUpdated> 
        <!--The plan type--> 
        <planTypeName>OCSUserHosting</planTypeName> 
      </plan> 
    </availablePlans> 
  </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::ModifyOrganizationPlan