CRMContract.Retrieve Method
The Retrieve method retrieves a contract.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal ContractId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string ContractId,
string ColumnSetXML
);
[C++]
public: String* Retrieve(
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 object to be retrieved. See CUserAuth.
ContractId
Specifies the ID of the contract to be retrieved.
ColumnSetXML
Specifies an 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 contract.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the requested contact information. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by contract.xsd.
Remarks
This method always returns a single object so any filter criteria specified in the ColumnSetXML parameter are ignored.
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#]
// strServer should be set with the name of the platform Web server
string strServer = "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://" + strServer + "/" + 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";
// CRMContract proxy object
Microsoft.Crm.Platform.Proxy.CRMContract contract = new Microsoft.Crm.Platform.Proxy.CRMContract ();
contract.Credentials = System.Net.CredentialCache.DefaultCredentials;
contract.Url = strDir + "CRMContract.srf";
string strErrorMsg;
string strContractId = "{A87D821C-DF25-4FA0-A4F6-E2F41AB2B336}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>title</column>";
strColumnSetXml += "<column>contractnumber</column>";
strColumnSetXml += "<column>totalprice</column>";
strColumnSetXml += "</columnset>";
// Retreive the contract
string strContractXml = contract.Retrieve(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