CRMLead.Create Method
The Create method creates a new lead.
Syntax
[Visual Basic .NET]
Public Function Create(
ByVal Caller As CUserAuth,
ByVal LeadXML As String
) As String
[C#]
public string Create(
CUserAuth Caller,
string LeadXML
);
[C++]
public: String* Create(
CUserAuth* Caller,
String* LeadXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvCreateLead privilege. See CUserAuth.
LeadXML
Specifies an XML string containing the lead information. The XML schema is described by lead.xsd.
Return Value
Returns a String type that specifies the ID of the newly created lead.
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#]
// 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;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for a new lead
string strLeadXml = "<lead>";
strLeadXml += "<lastname>Li</lastname>";
strLeadXml += "<firstname>Yan</firstname>";
strLeadXml += "<companyname>Northwind Traders</companyname>";
strLeadXml += "<ownerid type=\"" + Microsoft.Crm.Platform.Types.ObjectType.otSystemUser.ToString() +"\">";
strLeadXml += userAuth.UserId + "</ownerid>";
strLeadXml += "</lead>";
string strLeadId = lead.Create(userAuth, strLeadXml);
}
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