CRMContract.RetrieveByObjectAndParent Method
The RetrieveByObjectAndParent method retrieves all of the contracts associated with a particular object (account or contact). In the case of a contact, this API also returns all contracts that are associated with the parent account of the contact.
Syntax
[Visual Basic .NET]
Public Function RetrieveByObjectAndParent(
ByVal Caller As CUserAuth,
ByVal Object As CObjectName,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveByObjectAndParent(
CUserAuth Caller,
CObjectName Object,
string ColumnSetXML
);
[C++]
public: String* RetrieveByObjectAndParent(
CUserAuth* Caller,
CObjectName* Object,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadContract privilege to perform this action. See CUserAuth.
Object
Specifies the object for which contracts are to be retrieved (account). 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 contract.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the set of retrieved contracts. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by contract.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#]
// 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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMContract proxy object
Microsoft.CRM.Proxy.CRMContract contract = new Microsoft.CRM.Proxy.CRMContract ();
contract.Credentials = System.Net.CredentialCache.DefaultCredentials;
contract.Url = strDir + "CRMContract.srf";
string strErrorMsg;
string strAccountId = "{FD42F065-174B-499C-90DA-0DE56405085A}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>title</column>";
strColumnSetXml += "</columnset>";
Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
objName.Id = strAccountId;
objName.Type = Microsoft.CRM.Proxy.ObjectType.otAccount;
// Retrieve all contracts that are associated with that account
// You will also retrieve the contracts that are associated with the parent of the account
string strContractsXml = contract.RetrieveByObjectAndParent(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