ALM Site Administration API Type Library 12.50 and later
GetLicenseStatus Method
SAapi Object : GetLicenseStatus Method
License per domain is not supported. Pass an empty string. Do not pass NULL.
Description
Returns the site license status.
Syntax
Visual Basic
Public Function GetLicenseStatus( _
   ByVal DomainName As String _
) As String
Parameters
DomainName
License per domain is not supported. Pass an empty string. Do not pass NULL.
Return Type
On success, returns the license data in XML format.
Return Value Details
TOLERANCE
License tolerance (Positive number). The number of licenses used above the quota that is accepted for a limited time by ALM. Always 0 if MODEL is PPU.
DAYSTOEXPIRATION
Number or days before expiration
MODEL
License model. One of PPU or Concurrent
LICENSE_TYPE
Type of license (Positive number). For meaning of LICENSE_TYPE values, see GetLicenseTypesList.
NAME
Name of license type
IS_ADDITIONAL
is additional license type (Y/N)
IS_COUNTED
is counted (Y/N)
MAX
license quota for current license type
INUSE
current used licenses
EXPIRATIONDATE
Date of expiration license type. Format of date: MM/dd/yyyy or literal string "UNLIMITED"
Return Value Example
Example Title
Copy Code 
<GetLicenseStatus>
    <TDXItem>
        <TOLERANCE>0</TOLERANCE>
        <DAYSTOEXPIRATION>25</DAYSTOEXPIRATION>
        <MODEL>PPU</MODEL>
        <LICENSES>
            <TDXItem>
                <NAME> Defects</NAME>
                <IS_ADDITIONAL>Y</IS_ADDITIONAL>
                <IS_COUNTED>Y</IS_COUNTED>
                <MAX>7</MAX>
                <INUSE>1</INUSE>
                <EXPIRATIONDATE> 03/01/2010</EXPIRATIONDATE>
                <LICENSE_TYPE>1</LICENSE_TYPE>
            </TDXItem>
            <TDXItem>
                <NAME> Defects</NAME>
                <IS_ADDITIONAL>N</IS_ADDITIONAL>
                <IS_COUNTED>Y</IS_COUNTED>
                <MAX>14</MAX>
                <INUSE>1</INUSE>
                <EXPIRATIONDATE> 03/01/2010</EXPIRATIONDATE>
                <LICENSE_TYPE>1</LICENSE_TYPE>
            </TDXItem>
        </LICENSES>
    </TDXItem>
</GetLicenseStatus>
See Also

SAapi Object  | SAapi Members