Hosted Office Communications Server::Subscribe

  • Article

This procedure subscribes to the Hosted Office Communications Server service.

Use this procedure to subscribe a specified organization to the Office Communications Server Hosted Service. This is a pre-requisite for an organization before any users in that organization can be provisioned for Office Communications Server.

Arguments

Input argument Required Type Description

<organization>

Yes

string

The Lightweight Directory Access Protocol (LDAP) path of the organization.

<preferredDomainController>

Yes

string

The domain controller to use for Active Directory actions.

<planName>

Yes

string

The Office Communications Server Hosting Plan to apply to 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::AddCustomerPlan, which tests the caller for the Customer Administrator (UserCreators).

Preconditions

  • The organizational unit was created in Active Directory by using Hosted Active Directory::CreateOrganization.

  • The Hosted Office Communications Server namespace has been initialized.

  • The specified organization plan has been created by using Hosted Office Communications Server::CreateOrganizationPlan.

Business Rules

The submitted plan name must be of plan type "OCSOrgHosting."

Post-conditions

  • The specified service plan will be assigned to the customer in the Plan Manager database.

  • The organization is enabled for the Office Communications Server service.

  • SIP Domains can be provisioned for the organization.

Sequence Narrative

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

  2. The Hosted Office Communications Server namespace calls an internal private helper GetPlanWithTypeValidation_ which will retrieve the plan details and validate that the plan is of type OCSOrgHosting.

  3. The Hosted Office Communications Server namespace calls Managed Plans::AddCustomerPlan to assign the specified plan to the customer organization.

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> 
    <!--The unique name of the desired service plan.--> 
    <planName>BasicOCS</planName> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="Subscribe" 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::Unsubscribe