Share via


CRMSalesOrder.CreateAndRetrieve Method

The CreateAndRetrieve method creates a sales order and then retrieves it.

Syntax

[Visual Basic .NET]
Public Function CreateAndRetrieve(
  ByVal Caller As CUserAuth,
  ByVal InSalesOrderXml As String
) As String
[C#]
public string CreateAndRetrieve(
  CUserAuth  Caller,
  string  InSalesOrderXml
);
[C++]
public: String* CreateAndRetrieve(
  CUserAuth*  Caller,
  String*  InSalesOrderXml
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvCreateOrder and prvReadOrder privileges. See CUserAuth.

InSalesOrderXml

Specifies an XML string containing the sales order information. The XML schema is described by salesorder.xsd.

Return Value

Returns a String type that specifies the XML data containing the newly created sales order information. The XML schema is described by salesorder.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#]
// 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 strCustomerId = "{CBDED4DD-CF90-43ED-85A9-0B33D205F9A6}";

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 </name>";
   xml += "<customerid type=\"" + Microsoft.Crm.Platform.Types.ObjectType.otAccount.ToString() +"\">";
   xml += strCustomerId + "</customerid>";
   xml += "<ownerid type=\"" + Microsoft.Crm.Platform.Types.ObjectType.otSystemUser.ToString() +"\">";
   xml += userAuth.UserId + "</ownerid>";
   xml += "</salesorder>";

   // Create the sales order, and then retrieve it
   string strSalesOrderXml = salesorder.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

© 2005 Microsoft Corporation. All rights reserved.