CRMContact.RetrieveByObject Method
The RetrieveByObject method retrieves contacts associated with the specified object (lead or opportunity).
Syntax
[Visual Basic .NET]
Public Function RetrieveByObject(
ByVal Caller As CUserAuth,
ByVal Object As CObjectName,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveByObject(
CUserAuth Caller,
CObjectName Object,
string ColumnSetXML
);
[C++]
public: String* RetrieveByObject(
CUserAuth* Caller,
CObjectName* Object,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadContact privilege to perform this action. See CUserAuth.
Object
Specifies the object (lead or opportunity) to search for. See CObjectName.
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 contact.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies XML data representing the set of contacts requrested. The fields that are returned depend on what fields are specified in the ColumnSet parameter. The XML schema is described by contact.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";
// CRMContact proxy object
Microsoft.CRM.Proxy.CRMContact contact = new Microsoft.CRM.Proxy.CRMContact ();
contact.Credentials = System.Net.CredentialCache.DefaultCredentials;
contact.Url = strDir + "CRMContact.srf";
string strErrorMsg;
string LeadId = "{CBF74720-0E3C-43D0-A8C5-CF2D77117F5B}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Create an object name structure for the lead
Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
objName.Id = strLeadId;
objName.Type = Microsoft.CRM.Proxy.ObjectType.otLead;
// Retrieve all the contacts for the specified object
string strContactsXml = contact.RetrieveByObject(userAuth, objName, "");
}
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