CRMSalesOrderDetail.RetrieveByObject Method
The RetrieveByObject method retrieves all sales order details that are associated with the specified object (sales order).
Syntax
[Visual Basic .NET]
Public Function RetrieveByObject(
ByVal Caller As CUserAuth,
ByVal Object As CObjectName,
ByVal ColumnSetXml As String
) As String
[C#]
public string RetrieveByObject(
CUserAuth Caller,
CObjectName Object,
string ColumnSetXml
);
[C++]
public: String* RetrieveByObject(
CUserAuth* Caller,
CObjectName* Object,
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadOrder privilege to perform this action. See CUserAuth.
Object
Specifies the object (sales order) for which associated sales order details are to be retrieved. See CObjectName.
ColumnSetXml
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in salesorderdetail.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the set of sales order details for the specified object. The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. The XML schema is described by salesorderdetail.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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMSalesOrderDetail proxy object
Microsoft.CRM.Proxy.CRMSalesOrderDetail salesorderdetail = new Microsoft.CRM.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.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "</columnset>";
// Initialize the sales order object
Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
objName.Id = strSalesOrderId;
objName.Type = Microsoft.CRM.Proxy.ObjectType.otSalesOrder;
// Retrieve the sales order details by sales order object
string strResultsXml = salesorderdetail.RetrieveByObject (userAuth, objName, 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.Proxy
Assembly: microsoft.crm.proxy.dll
See Also