CRMContact.RetrieveByPrincipal Method
The RetrieveByPrincipal method retrieves all the contacts 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. To perform this action, the caller must have the prvReadContact privilege and access rights on the objects to be retrieved. See CUserAuth.
Principal
Specifies the security principal whose contacts you want to retrieve. See CSecurityPrincipal.
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 contact.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies XML data representing the set of contacts requested. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. This XML string is in the format
<contacts> + contact1..N + </contacts>
where the XML schema for each contact is described by contact.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#]
// 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";
// CRMContact proxy object
Microsoft.Crm.Platform.Proxy.CRMContact contact = new Microsoft.Crm.Platform.Proxy.CRMContact ();
contact.Credentials = System.Net.CredentialCache.DefaultCredentials;
contact.Url = strDir + "CRMContact.srf";
string strErrorMsg;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>contactid</column>";
strColumnSetXml += "<column>lastname</column>";
strColumnSetXml += "</columnset>";
// Create a new security principal
Microsoft.Crm.Platform.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.Crm.Platform.Proxy.CSecurityPrincipal();
securityPrincipal.Id = userAuth.UserId;
securityPrincipal.Type = Microsoft.Crm.Platform.Proxy.SecurityPrincipalType.sptUser;
// Retrieve all the contacts for the specified security principal
string strContactsXml = contact.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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also