CRMOpportunity.RetrieveSharedPrincipalsAndAccess Method
The RetrieveSharedPrincipalsAndAccess method retrieves all of the security principals (users or teams) that have access to an opportunity and their access rights for that opportunity.
Syntax
[Visual Basic .NET]
Public Function RetrieveSharedPrincipalsAndAccess(
ByVal Caller As CUserAuth,
ByVal OpportunityId As String,
ByRef Rights As UInt32()
) As CSecurityPrincipal()
[C#]
public CSecurityPrincipal[] RetrieveSharedPrincipalsAndAccess(
CUserAuth Caller,
string OpportunityId,
out uint[] Rights
);
[C++]
public: CSecurityPrincipal* RetrieveSharedPrincipalsAndAccess(
CUserAuth* Caller,
String* OpportunityId,
unsigned long* Rights
) __gc[];
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadOpportunity privilege and access rights on the object to be retrieved. See CUserAuth.
OpportunityId
Specifies the ID of the opportunity.
Rights
[out] Specifies the array of rights that are found. See ACCESSRIGHTS.
Return Value
Returns a CSecurityPrincipal[] type that specifies the array of security principals associated with the specified opportunity. 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";
// CRMOpportunity proxy object
Microsoft.Crm.Platform.Proxy.CRMOpportunity opportunity = new Microsoft.Crm.Platform.Proxy.CRMOpportunity();
opportunity.Credentials = System.Net.CredentialCache.DefaultCredentials;
opportunity.Url = strDir + "CRMOpportunity.srf";
string strErrorMsg;
string strOpportunityId= "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
uint[] rights;
// Retrieve shared principals and their access rights
Microsoft.Crm.Platform.Proxy.CSecurityPrincipal[] securityPrincipals;
securityPrincipals = opportunity.RetrieveSharedPrincipalsAndAccess(userAuth, strOpportunityId, out rights);
}
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