Share via

Managed Office Communications Server::GetSipDomainsByOrganization

  • Article

This procedure retrieves an organization's SIP domains from the Office Communications Server.

Arguments

Input argument Required Type Description

<organization>

Yes

xs:string

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

<preferredDomainController>

Yes

xs:string

The domain controller to use for Active Directory actions
Output argument Type Description

<sipDomains>

xs:string

A collection of SIP Domains.

<sipDomains/ sipDomain >

A SIP Domain container.

<sipDomains/sipDomain/address>

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.

<sipDomains/sipDomain/owner>

xs:string

The owner of the SIP domain.This could be:

  • "Tenant" for SIP domains that are directly associated with the Tenant organization.

  • "Parent" for SIP domains that are defined at the parent.

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

The organization exists.

Business Rules

This should return the SIP domains fo both the organization and its parent.

Post-conditions

  • A collection of SIP domains is returned.

  • If there are no domains, an empty collection is returned.

Sequence Narrative

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

  2. The Managed Office Communications Server namespace retrieves a list of service pointers of the organization using the Managed Helpers::QueryServicePointers_ procedure.

  3. TheManaged Office Communications Server namespace calls GetOwningOrg_ to retrieve its parent.

  4. The Managed Office Communications Server namespace retrieves a list of service pointers of the organization's parent using the Managed Helpers::QueryServicePointers_ procedure.

  5. The list of service pointers is formatted and returned.

Sample Code

Example XML Request

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

Example XML Response

<response> 
  <data> 
    <!--A collection of SIP Domains.--> 
    <sipDomains> 
      <!--A SIP Domain container.--> 
      <sipDomain> 
        <!--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>sip.AlpineSkiHouse.com</address> 
        <!--The actual owner of the domain. It could be 'Tenant' if the organization has direct ownership of the domain, or 'Parent' if the parent of the organization owns the domain. If neither is true, an error will be thrown.--> 
        <owner>Tenant</owner> 
      </sipDomain> 
    </sipDomains> 
  </data> 
</response>

Applies To

Managed Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5