CRMLicense.GetUserUnassignedLicenses Method
The GetUserUnassignedLicenses method retrieves all of the unassigned software licenses for a user.
Syntax
[Visual Basic .NET]
Public Function GetUserUnassignedLicenses(
ByVal Caller As CUserAuth,
ByVal UserId As String
) As String
[C#]
public string GetUserUnassignedLicenses(
CUserAuth Caller,
string UserId
);
[C++]
public: String* GetUserUnassignedLicenses(
CUserAuth* Caller,
String* UserId
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadLicense privilege and access rights on the objects to be retrieved. 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 that are not yet assigned to the user. This XML string is in the format
<licenses> + license1..N + </licenses>
where the XML schema for each license is described by license.xsd.
Remarks
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";
// CRMLicense proxy object
Microsoft.Crm.Platform.Proxy.CRMLicense license = new Microsoft.Crm.Platform.Proxy.CRMLicense();
license.Credentials = System.Net.CredentialCache.DefaultCredentials;
license.Url = strDir + "CRMLicense.srf";
string strErrorMsg = "";
string strUserLicenses = "";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Now get the unassigned licenses for the user
strUserLicenses = license.GetUserUnassignedLicenses (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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also