CRMLead.Assign Method
The Assign method assigns the lead 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 LeadId As String,
ByVal Assignee As CSecurityPrincipal
)
[C#]
public void Assign(
CUserAuth Caller,
string LeadId,
CSecurityPrincipal Assignee
);
[C++]
public: void Assign(
CUserAuth* Caller,
String* LeadId,
CSecurityPrincipal* Assignee
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvAssignLead privilege and access rights on the object to be assigned. See CUserAuth.
LeadId
Specifies the ID of the lead to be assigned.
Assignee
Specifies the new owner of the lead. It can be a user or a team. See CSecurityPrincipal.
Return Value
No return value.
Remarks
Note The Microsoft CRM application does not support business-object assignment to teams. Therefore, any 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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMLead proxy object
Microsoft.Crm.Platform.Proxy.CRMLead lead = new Microsoft.Crm.Platform.Proxy.CRMLead ();
lead.Credentials = System.Net.CredentialCache.DefaultCredentials;
lead.Url = strDir + "CRMLead.srf";
string strErrorMsg;
string strLeadId = "{0876468B-8FC4-4381-8D81-C0B4D05E9386}";
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Create a new security principal
Microsoft.Crm.Platform.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.Crm.Platform.Proxy.CSecurityPrincipal();
securityPrincipal.Id = strUserId;
securityPrincipal.Type = Microsoft.Crm.Platform.Proxy.SecurityPrincipalType.sptUser;
// Assign the lead to another security principal
lead.Assign(userAuth, strLeadId, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also