CRMCustomerAddress.CreateAndRetrieve Method
The CreateAndRetrieve method creates a customer address and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function CreateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal EntityXml As String,
ByVal ColumnSet As String
) As String
[C#]
public string CreateAndRetrieve(
CUserAuth Caller,
string EntityXml,
string ColumnSet
);
[C++]
public: String* CreateAndRetrieve(
CUserAuth* Caller,
String* EntityXml,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. See CUserAuth.
EntityXml
Specifies the XML string containing the customer address information. The XML schema is described by customeraddress.xsd.
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.
Return Value
Returns a String type that specifies the XML data containing the newly created customer address information. The XML schema is described by customeraddress.xsd.
Remarks
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 = "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";
// 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>";
// Set up the XML string for a new customer address
string strCustomerAddressXML = "<customeraddress><name>Customer name 1</name> ";
strCustomerAddressXML += "<parentid>" + strAccountId + "</parentid>";
strCustomerAddressXML += "<addressnumber>0</addressnumber>";
strCustomerAddressXML += "<objecttypecode>" + Microsoft.Crm.Platform.Types.CUSTOMER_ADDRESS_TYPE.CAT_ACCOUNT + "</objecttypecode>";
strCustomerAddressXML += "</customeraddress>";
// Create and then retrieve the customer address
string strCustomerAddressXml = customeraddress.CreateAndRetrieve (userAuth,strCustomerAddressXML,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