BizOrganization.Delete Method
The Delete method deletes an organization. The organization, as well as all its business hierarchies, users, teams, and objects (such as accounts and contacts), are physically deleted from the database. To perform this action, the caller must be a domain administrator.
Syntax
[Visual Basic .NET]
Public Sub Delete(
ByVal OrganizationId As String
)
[C#]
public void Delete(
string OrganizationId
);
[C++]
public: void Delete(
String* OrganizationId
);
Parameters
OrganizationId
Specifies the ID of the organization. This ID is obtained when you create the Organizational Unit in Active Directory.
Return Value
No return value.
Remarks
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
Note The following example contains sample data for the administrator login name and password. This is for illustration only. User credentials should never be hard-coded. For more information, see "Building Secure ASP.NET Applications" at msdn.microsoft.com/library/default.asp?url=/library/en-us/dnnetsec/html/SecNetch12.asp.
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizOrganization proxy object
Microsoft.Crm.Platform.Proxy.BizOrganization organization = new Microsoft.Crm.Platform.Proxy.BizOrganization ();
organization.Credentials = System.Net.CredentialCache.DefaultCredentials;
organization.Url = strDir + "BizOrganization.srf";
string strOrgXML = "";
string strOrgName = "Wingtip Toys";
// Get the GUID of an OU from Active Directory
// that is going to represent the OU for the Microsoft CRM organization object
// The name of the OU should be the same as the name of the Microsoft CRM organization
// The organization is created in Microsoft CRM
string strOrgId = "{3BECB6A6-0DD8-4061-98D9-0B9E897C5027}";
// See Note above regarding the use of hard-coded passwords
string strDomainAdminUserName = "Administrator";
string strDomainAdminUserPass = "Admin";
string strDomainName = "MyDomain";
string strErrorMsg = "";
try
{
// Set the credentials of organization proxy with
// credentials of a user that has domain administrator rights
organization.Credentials = new System.Net.NetworkCredential( strDomainAdminUserName,
strDomainAdminUserPass,
strDomainName);
// Delete the organization
oOrganization.Delete(strOrgId);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
finally
{
// Set the credentials back to the default
organization.Credentials = System.Net.CredentialCache.DefaultCredentials;
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also