Share via

CRMLicense.GetAvailableLicenseCount Method

  • Article

The GetAvailableLicenseCount method retrieves the number of available (un-granted) software licenses of a particular license type for an organization.

Syntax

[Visual Basic .NET]
Public Function GetAvailableLicenseCount(
  ByVal Caller As CUserAuth,
  ByVal OrganizationId As String,
  ByVal LicenseType As String
) As Integer
[C#]
public int GetAvailableLicenseCount(
  CUserAuth  Caller,
  string  OrganizationId,
  string  LicenseType
);
[C++]
public: long GetAvailableLicenseCount(
  CUserAuth*  Caller,
  String*  OrganizationId,
  String*  LicenseType
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadLicense privilege to perform this action. See CUserAuth.

OrganizationId

Specifies the ID of the organization.

LicenseType

Specifies the ID of the license type in which you are interested.

Return Value

Returns an Int32 type that specifies the number of available software licenses.

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 = "";
// Valid organization ID
string strOrgId = "{3BECB6A6-0DD8-4061-98D9-0B9E897C5027}" ;
// Microsoft CRM Suite Professional
string LicenseType = "{59F6D48E-F7E8-46F3-806C-3CA992D21915}";

int count = -1;
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Now retrieve license count
   count = license.GetAvailableLicenseCount(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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.