CRMContractDetail.RetrieveByContract Method
The RetrieveByContract method retrieves the contract detail line items for the specified contract ID.
Syntax
[Visual Basic .NET]
Public Function RetrieveByContract(
ByVal Caller As CUserAuth,
ByVal ContractId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveByContract(
CUserAuth Caller,
string ContractId,
string ColumnSetXML
);
[C++]
public: String* RetrieveByContract(
CUserAuth* Caller,
String* ContractId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadContract privilege and access rights on the objects to be retrieved. See CUserAuth.
ContractlId
Specifies the ID of the contract for which the contract detail is to be retrieved.
ColumnSetXML
Specifies the XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). You can find the valid column names in contractdetail.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the contract detail information. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. This XML string is in the format
<contractdetails> + contractdetail1..N + </contractdetails>
where the XML schema for each contract is described by contractdetail.xsd.
Remarks
Unlike the Retrieve method, the XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.
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";
// CRMContractDetail proxy object
Microsoft.Crm.Platform.Proxy.CRMContractDetail contractdetail = new Microsoft.Crm.Platform.Proxy.CRMContractDetail();
contractdetail.Credentials = System.Net.CredentialCache.DefaultCredentials;
contractdetail.Url = strDir + "CRMContractDetail.srf";
string strErrorMsg;
string strColumnSetXml;
string strContractId = "{AE6C8B20-3SDF-4C83-9986-57719B8DA83D}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>contractdetailid</column>";
strColumnSetXml += "<column>title</column>";
strColumnSetXml += "</columnset>";
// Retrieve the contract detail
string strResultsXml = contractdetail.RetrieveByContract(userAuth, strContractId, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also