CRMSalesOrderDetail.CreateAndRetrieve Method
The CreateAndRetrieve method creates a sales order detail and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function CreateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal InSalesOrderDetailXml As String
) As String
[C#]
public string CreateAndRetrieve(
CUserAuth Caller,
string InSalesOrderDetailXml
);
[C++]
public: String* CreateAndRetrieve(
CUserAuth* Caller,
String* InSalesOrderDetailXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, To perform this action, the caller must have prvCreateOrder, prvAppendToOrder, and prvReadOrder privileges. See CUserAuth.
InSalesOrderDetailXml
Specifies an XML string containing the new sales order detail information. The XML schema is described by salesorderdetail.xsd.
Return Value
Returns a String type that specifies the XML data containing the sales order detail. The XML schema is described by salesorderdetail.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";
// CRMSalesOrderDetail proxy object
Microsoft.Crm.Platform.Proxy.CRMSalesOrderDetail salesorderdetail = new Microsoft.Crm.Platform.Proxy.CRMSalesOrderDetail();
salesorderdetail.Credentials = System.Net.CredentialCache.DefaultCredentials;
salesorderdetail.Url = strDir + "CRMSalesOrderDetail.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 detail
string xml = "<salesorderdetail>";
xml += "<description>Test Sales Order Detail</description>";
xml += "<salesorderid>" + strSalesOrderId + "</salesorderid>";
xml += "</salesorderdetail>";
// Create the sales order detail, and then retrieve it
string strResultsXml = salesorderdetail.CreateAndRetrieve(userAuth, 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