Managed Office Communications Server::DeleteSipDomain
This procedure removes an existing SIP domain from 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
The specified organization has a service pointer for the specified domain.
Post-conditions
The service pointer will be removed for the specified organization.
Sequence Narrative
Actor submits DeleteSipDomain request to the Managed Office Communications Server namespace.
The Managed Office Communications Server namespace verifies that the SIP domain is part of the owning organization using private internal procedure IsSipDomainOwnedBy_.
If the owner is not owned by the organizatiaion, throw an InvalidOperationException (0x80131509) using Error Provider::SetError.
The Managed Office Communications Server namespace calls Managed Helpers::DeleteServicePointer to remove the associated service pointer.
Exceptions
HResult | Message | Conditions |
---|---|---|
0x80131509 |
The specified SIP domain '%1' does not belong to '%2'. Note: %1 should be the domain value Note: %2 should be the LDAP path of the organization. |
SIP Domain does not belong to the organization. |
Sample Code
Example XML Request
<request>
<data>
<!--LDAP path of the organization-->
<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-->
<address>AlpineSkiHouse.com</address>
</data>
<procedure>
<execute namespace="Managed Office Communications Server" procedure="DeleteSipDomain" 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
Managed Office Communications Server Namespace API for:
- Hosted Messaging and Collaboration version 4.5