CRMSalesOrder.RevokeAccess Method

  • Article

The RevokeAccess method revokes access rights to the sales order for the specified security principal. This method also applies to all child objects of the sales order. For all child objects, if the caller does not have share privileges for those object types or share rights to the objects, access to the child objects is not revoked. As a result, the owner of the object or a user who shares the object with share rights automatically has share rights to all child objects of the sales order. In this case, only the lack of privileges to a particular object type prevents access to the child objects from being revoked.

Syntax

[Visual Basic .NET]
Public Sub RevokeAccess(
  ByVal Caller As CUserAuth,
  ByVal SalesOrderId As String,
  ByVal Principal As CSecurityPrincipal
)
[C#]
public void RevokeAccess(
  CUserAuth  Caller,
  string  SalesOrderId,
  CSecurityPrincipal  Principal
);
[C++]
public: void RevokeAccess(
  CUserAuth*  Caller,
  String*  SalesOrderId,
  CSecurityPrincipal*  Principal
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvShareOrder privilege to perform this action. See CUserAuth.

SalesOrderId

Specifies the ID of the sales order for which access is to be revoked.

Principal

Specifies the security principal (user or team) for which access is to be revoked. See CSecurityPrincipal.

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#]
// strServerName should be set with the name of the platform Web server
string strServerName = "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://" + strServerName + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMSalesOrder proxy object
Microsoft.CRM.Proxy.CRMSalesOrder salesorder = new Microsoft.CRM.Proxy.CRMSalesOrder ();
salesorder.Credentials = System.Net.CredentialCache.DefaultCredentials;
salesorder.Url = strDir + "CRMSalesOrder.srf";

string strErrorMsg;
string strSalesOrderId = "{37F05EC6-0A39-400E-84D1-CCD9F72F034F}";

try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
   
   // Intialize the security principal
   Microsoft.CRM.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.CRM.Proxy.CSecurityPrincipal();
   securityPrincipal.Id = userAuth.UserId;
   securityPrincipal.Type = Microsoft.CRM.Proxy.SecurityPrincipalType.sptUser;

   // Revoke access to the sales order
   salesorder.RevokeAccess (userAuth, strSalesOrderId, securityPrincipal);
}
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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.