CRMContract.RetrieveByPrincipal Method
The RetrieveByPrincipal method retrieves all of the contracts that are owned by a security principal (user or team).
Syntax
[Visual Basic .NET]
Public Function RetrieveByPrincipal(
ByVal Caller As CUserAuth,
ByVal Principal As CSecurityPrincipal,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveByPrincipal(
CUserAuth Caller,
CSecurityPrincipal Principal,
string ColumnSetXML
);
[C++]
public: String* RetrieveByPrincipal(
CUserAuth* Caller,
CSecurityPrincipal* Principal,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadContract privilege to perform this action. See CUserAuth.
Principal
Specifies the security principal whose contracts you want to retrieve. See CSecurityPrincipal.
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;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>contractid</column>";
strColumnSetXml += "</columnset>";
// Create a new security principal
Microsoft.CRM.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.CRM.Proxy.CSecurityPrincipal();
securityPrincipal.Id = userAuth.UserId;
securityPrincipal.Type = Microsoft.CRM.Proxy.SecurityPrincipalType.sptUser;
// Retrieve all of the contracts for the specified security principal
string strContractsXml = contract.RetrieveByPrincipal(userAuth, securityPrincipal, 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