CRMLead.RetrieveSharedPrincipals Method
The RetrieveSharedPrincipals method retrieves all of the security principals (users or teams) that have access to a lead.
Syntax
[Visual Basic .NET]
Public Function RetrieveSharedPrincipals(
ByVal Caller As CUserAuth,
ByVal LeadId As String,
ByVal Rights As UInt32
) As CSecurityPrincipal()
[C#]
public CSecurityPrincipal[] RetrieveSharedPrincipals(
CUserAuth Caller,
string LeadId,
uint Rights
);
[C++]
public: CSecurityPrincipal* RetrieveSharedPrincipals(
CUserAuth* Caller,
String* LeadId,
unsigned long Rights
) __gc[];
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadLead privilege and access rights on the object to be retrieved. See CUserAuth.
LeadId
Specifies the ID of the lead.
Rights
Specifies the rights for access to this lead. See ACCESSRIGHTS.
Return Value
Returns a CSecurityPrincipal[] type that specifies an array of security principals requested. See CSecurityPrincipal.
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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMLead proxy object
Microsoft.Crm.Platform.Proxy.CRMLead lead = new Microsoft.Crm.Platform.Proxy.CRMLead ();
lead.Credentials = System.Net.CredentialCache.DefaultCredentials;
lead.Url = strDir + "CRMLead.srf";
string strErrorMsg;
string strLeadId = "{0876468B-8FC4-4381-8D81-C0B4D05E9386}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
Microsoft.Crm.Platform.Proxy.CSecurityPrincipal[] securityPrincipals;
securityPrincipals = lead.RetrieveSharedPrincipals(userAuth, strLeadId, Microsoft.Crm.Platform.Types.AccessRights.CRM_ACCESS_READ);
}
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