CRMSalesOrder.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates a sales order and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal SalesOrderId As String,
ByVal InSalesOrderXml As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string SalesOrderId,
string InSalesOrderXml
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* SalesOrderId,
String* InSalesOrderXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteOrder and prvReadOrder privileges and access rights on the object to be updated. See CUserAuth.
SalesOrderId
Specifies the ID of the sales order to be updated.
InSalesOrderXml
Specifies an XML string containing the new sales order information. The XML schema is described by salesorder.xsd.
Return Value
Returns a String type that specifies the XML data containing the updated sales order information. The XML schema is described by salesorder.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#]
// strServerName should be set with the name of the platform Web server
string strServerName = "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://" + strServerName + "/" + 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";
// CRMSalesOrder proxy object
Microsoft.Crm.Platform.Proxy.CRMSalesOrder salesorder = new Microsoft.Crm.Platform.Proxy.CRMSalesOrder ();
salesorder.Credentials = System.Net.CredentialCache.DefaultCredentials;
salesorder.Url = strDir + "CRMSalesOrder.srf";
string strErrorMsg;
string strSalesOrderId = "{B329D5A4-4EDF-41C5-A06A-6BA123B73D5D}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the sales order
string xml = " <salesorder>";
xml += "<name>Test Sales Order updated </name>";
xml += "</salesorder>";
// Update the sales order, and then retrieve it
string strResultXml = salesorder.UpdateAndRetrieve (userAuth, strSalesOrderId, xml);
}
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