CRMLead.Retrieve Method
The Retrieve method retrieves a lead by ID.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal LeadId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string LeadId,
string ColumnSetXML
);
[C++]
public: String* Retrieve(
CUserAuth* Caller,
String* LeadId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadLead privilege to perform this action. See CUserAuth.
LeadId
Specifies the ID of the lead that is to be retrieved.
ColumnSetXML
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in lead.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the requested lead information. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by lead.xsd.
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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMLead proxy object
Microsoft.CRM.Proxy.CRMLead lead = new Microsoft.CRM.Proxy.CRMLead ();
lead.Credentials = System.Net.CredentialCache.DefaultCredentials;
lead.Url = strDir + "CRMLead.srf";
string strErrorMsg;
string strLeadId = "{0876468B-8FC4-4381-8D81-C0B4D05E9386}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Now retrieve this lead
// Passing in a null string for ColumnSet retrieves all columns
string strNewLeadXml = lead.Retrieve(userAuth, strLeadId, "");
}
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