CRMLicense.GetUserLicenses Method
The GetUserLicenses method retrieves all of the software licenses for a user.
Syntax
[Visual Basic .NET]
Public Function GetUserLicenses(
ByVal Caller As CUserAuth,
ByVal UserId As String
) As String
[C#]
public string GetUserLicenses(
CUserAuth Caller,
string UserId
);
[C++]
public: String* GetUserLicenses(
CUserAuth* Caller,
String* UserId
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadLicense privilege to perform this action. See CUserAuth.
UserId
Specifies ID of the user.
Return Value
Returns a String type that specifies the XML data containing the set of software licenses associated with the specified user. The XML schema is described by license.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";
// CRMLicense proxy object
Microsoft.CRM.Proxy.CRMLicense license = new Microsoft.CRM.Proxy.CRMLicense();
license.Credentials = System.Net.CredentialCache.DefaultCredentials;
license.Url = strDir + "CRMLicense.srf";
string strErrorMsg = "";
string strUserLicenses = "";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Now retrieve the licenses for the caller
strUserLicenses = license.GetUserLicenses(userAuth, userAuth.UserId);
}
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