CRMLicense.GetGrantedLicenseCount Method
The GetGrantedLicenseCount method returns the number of software licenses of a particular license type that have been granted in an organization.
Syntax
[Visual Basic .NET]
Public Function GetGrantedLicenseCount(
ByVal Caller As CUserAuth,
ByVal OrganizationId As String,
ByVal LicenseType As String
) As Integer
[C#]
public int GetGrantedLicenseCount(
CUserAuth Caller,
string OrganizationId,
string LicenseType
);
[C++]
public: long GetGrantedLicenseCount(
CUserAuth* Caller,
String* OrganizationId,
String* LicenseType
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadLicense privilege. See CUserAuth.
OrganizationId
Specifies the ID of the organization.
LicenseType
Specifies the ID of the license type.
Return Value
Returns an Int32 type that specifies the number of software licenses that have been granted.
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";
// 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 strOrgId = "{3BECB6A6-0DD8-4061-98D9-0B9E897C5027}"; //Valid Organization Id
string LicenseType = "{59F6D48E-F7E8-46F3-806C-3CA992D21915}"; //Profesional Suite
int lcount = -1;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Now retrieve the granted license count
lcount = license.GetGrantedLicenseCount(userAuth, strOrgId, LicenseType);
}
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