CRMCustomerAddress.RetrieveByObject Method

CRM 1.0

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 RetrievePrimaryCustomerAddresses As Integer,
  ByVal ColumnSet As String
) As String
[C#]
public string RetrieveByObject(
  CUserAuth  Caller,
  CObjectName  Object,
  int  RetrievePrimaryCustomerAddresses,
  string  ColumnSet
);
[C++]
public: String* RetrieveByObject(
  CUserAuth*  Caller,
  CObjectName*  Object,
  long  RetrievePrimaryCustomerAddresses,
  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

Specifies which addresses to retrieve. If the parameter is set to one (1), all addresses associated with that specific Account or Contact are retrieved. If this parameter is set to zero (0), only addresses listed on the More Addresses tab on the Account or Contact forms are retrieved; address1 and address2 are not retrieved.

ColumnSet

Specifies the XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or ""in VB .NET). 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. This XML string is in the format

<customeraddresses> + customeraddress1..N + </customeraddresses>

where the XML schema for each customer address is described by customeraddress.xsd.

Remarks

Unlike the Retrieve method, the XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.

The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.

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 = "http://" + 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";

// CRMCustomerAddress proxy object
Microsoft.Crm.Platform.Proxy.CRMCustomerAddress  customeraddress = new Microsoft.Crm.Platform.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.Platform.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.Platform.Proxy.CObjectName objName = new Microsoft.Crm.Platform.Proxy.CObjectName();
   objName.Id = strAccountId;
   objName.Type = Microsoft.Crm.Platform.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.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also


© 2005 Microsoft Corporation. All rights reserved.


Show: