Hosted Office Communications Server::CreateSipDomain

This procedure creates a new SIP Domain for the 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::GetPlansByCustomer and Managed Office Communications Server::CreateSipDomain, which perform a check for Customer Administrator (UserCreators).

Preconditions

The organization is subscribed to the Hosted Office Communications Server service.

Business Rules

None.

Post-conditions

An associated service pointer will be created for the SIP Domain.

Sequence Narrative

1. Actor submits CreateSipDomain 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 the Managed Office Communications Server::CreateSipDomain procedure, which will do the actual work of creating the SIP Domain.

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 domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--The fully qualified domain name (FQDN) of a domain handled by the Office Communications Server. The value must be the FQDN. An IP address is not allowed.--> 
    <address>AlpineSkiHouse.com</address> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="CreateSipDomain" impersonate="1"> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="address" 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::DeleteSipDomain