CRMContract.Assign Method

  • Article

The Assign method assigns the contract to a security principal (user or team). (See Remarks.) This method also applies to the parent object and associated objects that have the same owner as the parent object. Therefore when you assign the parent object to a new owner, only the associated objects that have the same owner as the parent object are assigned. In addition, when an object is assigned to a new owner, it is shared with the previous owner with full rights. Either the new owner or the previous owner can remove the relationship or lower the level of privileges the previous owner had on the object.

Syntax

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

Parameters

Caller

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

ContractId

Specifies the ID of the contract that is to be assigned.

Assignee

Specifies the team or user to which the account is to be assigned. See CSecurityPrincipal.

Return Value

No return value.

Remarks

Note   The Microsoft CRM application does not support business-object assignments to teams. Therefore, solutions built by using this method are not supported by the Microsoft CRM application.

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#]
// 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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

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

string strErrorMsg;
string strContractId = "{A87D821C-DF25-4FA0-A4F6-E2F41AB2B336}"; 
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";

try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Create a new security principal
   Microsoft.CRM.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.CRM.Proxy.CSecurityPrincipal();
   securityPrincipal.Id = strUserId;
   securityPrincipal.Type = Microsoft.CRM.Proxy.SecurityPrincipalType.sptUser;

   // Assign the contract to another security principal
   contract.Assign(userAuth, strContractId, 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.