CRMInvoice.RetrieveSharedPrincipalsAndAccess Method
The RetrieveSharedPrincipalsAndAccess method retrieves all security principals (users or teams) that have access to an invoice and their access rights to that invoice.
Syntax
[Visual Basic .NET]
Public Function RetrieveSharedPrincipalsAndAccess(
ByVal Caller As CUserAuth,
ByVal InvoiceId As String,
ByRef Rights As UInt32()
) As CSecurityPrincipal()
[C#]
public CSecurityPrincipal[] RetrieveSharedPrincipalsAndAccess(
CUserAuth Caller,
string InvoiceId,
out uint[] Rights
);
[C++]
public: CSecurityPrincipal* RetrieveSharedPrincipalsAndAccess(
CUserAuth* Caller,
String* InvoiceId,
unsigned long* Rights
) __gc[];
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadInvoice privilege and access rights on the object to be retrieved. See CUserAuth.
InvoiceId
Specifies the ID of the invoice.
Rights
[out] Specifies an array of rights for the principals that are found. See ACCESSRIGHTS.
Return Value
Returns a CSecurityPrincipal[] type that specifies the array of security principals that are found. 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";
// CRMInvoice proxy object
Microsoft.Crm.Platform.Proxy.CRMInvoice invoice = new Microsoft.Crm.Platform.Proxy.CRMInvoice();
invoice.Credentials = System.Net.CredentialCache.DefaultCredentials;
invoice.Url = strDir + "CRMInvoice.srf";
string strErrorMsg;
string strInvoiceId = "{A9920C07-EE2A-3434-A7EC-9J9D240CF535}";
uint[] rights;
Microsoft.Crm.Platform.Proxy.CSecurityPrincipal[] securityPrincipals;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
securityPrincipals = invoice.RetrieveSharedPrincipalsAndAccess(userAuth, strInvoiceId, 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