CRMCustomerAddress.RetrieveByObject Method
The RetrieveByObject method retrieves all addresses that are associated with an object (account or contact).
Syntax
[Visual Basic .NET]
Public Function RetrieveByObject(
ByVal Caller As CUserAuth,
ByVal Object As CObjectName,
ByVal RetrievePrimarySites As Integer,
ByVal ColumnSet As String
) As String
[C#]
public string RetrieveByObject(
CUserAuth Caller,
CObjectName Object,
int RetrievePrimarySites,
string ColumnSet
);
[C++]
public: String* RetrieveByObject(
CUserAuth* Caller,
CObjectName* Object,
long RetrievePrimarySites,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. See CUserAuth.
Object
Specifies the object (account or contact) for which customer addresses are to be retrieved. See CObjectName.
RetrievePrimaryCustomerAddresses
If true, addresses 1 and 2 are both retrieved.
ColumnSet
Specifies the 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 customeraddress.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the set of customer addresses associated with the specified account or contact. The fields that are returned depend on what fields are specified in the ColumnSet parameter. The XML schema is described by customeraddress.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";
// CRMCustomerAddress proxy object
Microsoft.CRM.Proxy.CRMCustomerAddress customeraddress = new Microsoft.CRM.Proxy.CRMCustomerAddress ();
customeraddress.Credentials = System.Net.CredentialCache.DefaultCredentials;
customeraddress.Url = strDir + "CRMCustomerAddress.srf";
string strErrorMsg;
string strAccountId = "{3E24E79C-7EC5-4473-95FF-7E46FEBB534B}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>customeraddressid</column>";
strColumnSetXml += "</columnset>";
// Instantiate an account object
Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
objName.Id = strAccountId;
objName.Type = Microsoft.CRM.Proxy.ObjectType.otAccount;
// Retrieve all of the customer addresses for the specified object
string strResultsXml = customeraddress.RetrieveByObject(userAuth, objName, 1, strColumnSetXml);
}
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