Hosted Office Communications Server::GetSipDomainsByOrganization

  • Article

This procedure gets all SIP domains assigned to an organization.

Use this procedure to retrieve a listing of SIP domains assigned to an organization.

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

No explicit permission check is required for this procedure. The procedure calls Managed Plans::GetPlansByCustomer and Managed Office Communications Server::GetSipDomainsByOrganization, which perform a check for Customer Administrator (UserCreators).

Preconditions

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

Business Rules

This should return the SIP Domains for both the organization and its parent.

Post-conditions

None.

Sequence Narrative

  1. Actor submits GetSipDomainsByOrganization 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 nmespace calls Managed Office Communications Server::GetSipDomainsByOrganization.

  4. A listing of SIP domains is returned. If the organization has no SIP domains an empty <sipDomains> collection is returned.

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> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="GetSipDomainsByOrganization" 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> 
    <!--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>n> 
      </sipDomain> 
    </sipDomains> 
  </data> 
</response>

Applies To

Hosted Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5