CRMSalesOrder.GrantAccess Method

  • Article

The GrantAccess method grants a security principal access to the specified sales order. 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, the child objects are not shared. 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 for a particular object type prevents the child objects from being shared.

Syntax

[Visual Basic .NET]
Public Sub GrantAccess(
  ByVal Caller As CUserAuth,
  ByVal SalesOrderId As String,
  ByVal Rights As UInt32,
  ByVal Principal As CSecurityPrincipal
)
[C#]
public void GrantAccess(
  CUserAuth  Caller,
  string  SalesOrderId,
  uint  Rights,
  CSecurityPrincipal  Principal
);
[C++]
public: void GrantAccess(
  CUserAuth*  Caller,
  String*  SalesOrderId,
  unsigned long  Rights,
  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 that is to be shared.

Rights

Specifies the rights that are to be granted. See ACCESSRIGHTS.

Principal

Specifies the security principal (user or team) with whom the sales order is to be shared. 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;

   // Set up the rights
   uint rights = Microsoft.CRM.Flags.AccessRights.CRM_ACCESS_WRITE;

   // Grant access to the sales order
   salesorder.GrantAccess  (userAuth, strSalesOrderId, rights, 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.