Share via

Managed Office Communications Server::CreateSipDomain

  • Article

This procedure creates a new SIP domain in the Office Communications Server for the specified organization.

Arguments

Input argument Required Type Description

<organization>

Yes

xs:string

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

<preferredDomainController>

Yes

xs:string

The domain controller to use for Active Directory actions.

<address>

Yes

xs:string

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.

Remarks

Security

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

Permission Check

This procedure will perform a test for Customer Administrator (UserCreators).

Preconditions

  • Managed Office Communications Server has been initialized.

  • The organization exists.

Business Rules

The domain must be globally unique.

Post-conditions

The organization will contain a service pointer with that SIP domain.

Sequence Narrative

  1. Actor submits CreateSipDomain request to the Managed Office Communications Server namespace.

  2. The Managed Office Communications Server namespace calls Managed Helpers::CreateServicePointer to add a new SIP Domain to the SIPDomains container.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The preferred domain controller for Active Directory operations.--> 
    <preferredDomainController>AD01.Fabrikam.com</preferredDomainController> 
    <!--The LDAP path of the organization--> 
    <organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</organization> 
    <!--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="Managed Office Communications Server" procedure="CreateSipDomain" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="organization" 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

Managed Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5

See also

Tasks

Managed Office Communications Server::DeleteSipDomain