BizMerchant.Disable Method
The Disable method disables a business unit and all of its child business units. No user in the business unit can log on to the Microsoft CRM service after the business unit is disabled.
Syntax
[Visual Basic .NET]
Public Sub Disable(
ByVal Caller As CUserAuth,
ByVal BusinessId As String,
ByVal Reason As String
)
[C#]
public void Disable(
CUserAuth Caller,
string BusinessId,
string Reason
);
[C++]
public: void Disable(
CUserAuth* Caller,
String* BusinessId,
String* Reason
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvDisableBusinessUnit privilege and access rights on the object to be disabled. See CUserAuth.
BusinessId
Specifies the ID of the business unit to be disabled. This ID is specified by the platform and obtained at creation time.
Reason
Specifies the reason for disabling the business unit.
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
[C#]
// It is assumed that the caller has the privileges to perform this action
// 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 + "/";
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// BizMerchant proxy object
Microsoft.Crm.Platform.Proxy.BizMerchant merchant = new Microsoft.Crm.Platform.Proxy.BizMerchant ();
merchant.Credentials = System.Net.CredentialCache.DefaultCredentials;
merchant.Url = strDir + "BizMerchant.srf";
string strErrorMsg;
string strBusinessId = "{4807B998-6B4F-4D57-9CF6-515F50E43D79}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Disable the merchant
merchant.Disable(userAuth, strBusinessId, "In Bankruptcy Proceedings");
}
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 );
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also