CRMQuote.RetrieveByObject Method
The RetrieveByObject method retrieves all quotes that are associated with an object (account, contact, or quote).
Syntax
[Visual Basic .NET]
Public Function RetrieveByObject(
ByVal Caller As CUserAuth,
ByVal Object As CObjectName,
ByVal StateCodes As Integer(),
ByVal ColumnSetXml As String
) As String
[C#]
public string RetrieveByObject(
CUserAuth Caller,
CObjectName Object,
int[] StateCodes,
string ColumnSetXml
);
[C++]
public: String* RetrieveByObject(
CUserAuth* Caller,
CObjectName* Object,
long StateCodes __gc[],
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadQuote privilege to perform this action. See CUserAuth.
Object
Specifies the object (account, contact, or quote) for which you want to retrieve associated quotes. See CObjectName.
StateCodes
Specifies an array of state codes to find. See QUOTE_STATE.
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 quote.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the set of quotes associated with the specified object (account, contact, or quote). The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. The XML schema is described by quote.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";
// CRMQuote proxy object
Microsoft.CRM.Proxy.CRMQuote quote = new Microsoft.CRM.Proxy.CRMQuote();
quote.Credentials = System.Net.CredentialCache.DefaultCredentials;
quote.Url = strDir + "CRMQuote.srf";
string strErrorMsg;
string strColumnSetXml;
string strAccountId = "{CBDED4DD-CF90-43ED-85A9-0B33D205F9A6}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "<column>accountid</column>";
strColumnSetXml += "</columnset>";
// Initialize the account object
Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
objName.Id = strAccountId;
objName.Type = Microsoft.CRM.Proxy.ObjectType.otAccount;
// An array of state codes to find
int[] arrCodes = new int[] {Microsoft.CRM.Flags.INVOICE_STATE.INS_ACTIVE,Microsoft.CRM.Flags.QUOTE_STATE.QS_ACTIVE};
// Retrieve the quotes for the account
string strResultsXml = quote.RetrieveByObject (userAuth, objName, arrCodes, 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