ALM Site Administration API Type Library 12.50 and later
GetLicenseConsumption Method
SAapi Object : GetLicenseConsumption Method
If the DomainName argument is empty, usage is return for the entire site. Otherwise, returns empty response. License per domain is not supported.
yyyy-mm-dd, for example 2010-05-26. The beginning of the period for which to check. If NULL, checks from date of first use of license.
yyyy-mm-dd. The end of the period for which to check. If NULL, check until today.
Description
Returns the PPU licenses that were used in the specified domain during the specified time period.
Syntax
Visual Basic
Public Function GetLicenseConsumption( _
   ByVal DomainName As String, _
   ByVal Start As String, _
   ByVal End As String _
) As String
Parameters
DomainName
If the DomainName argument is empty, usage is return for the entire site. Otherwise, returns empty response. License per domain is not supported.
Start
yyyy-mm-dd, for example 2010-05-26. The beginning of the period for which to check. If NULL, checks from date of first use of license.
End
yyyy-mm-dd. The end of the period for which to check. If NULL, check until today.
Return Type
On success, returns an XML string containing the licence consumption data.
Remarks
For meaning of LICENSE_TYPE values, see GetLicenseTypesList.
Return Value Example

<GetLicenseConsumption>
    <TDXItem>
        <DATE_TIME>01/02/09 11:41:08</DATE_TIME>
        <LICENSE>
            <TDXItem>
                <LICENSE_TYPE>1</LICENSE_TYPE>
                <COUNT_OF_LICENSES>10</COUNT_OF_LICENSES>
            </TDXItem>
            <TDXItem>
                <LICENSE_TYPE>2</LICENSE_TYPE>
                <COUNT_OF_LICENSES>10</COUNT_OF_LICENSES>
            </TDXItem>
        </LICENSE>
    </TDXItem>
    <TDXItem>
        <DATE_TIME>01/03/09 11:41:07</DATE_TIME>
        <LICENSE>
            <TDXItem>
                <LICENSE_TYPE>2</LICENSE_TYPE>
                <COUNT_OF_LICENSES>10</COUNT_OF_LICENSES>
            </TDXItem>
            <TDXItem>
                <LICENSE_TYPE>3</LICENSE_TYPE>
                <COUNT_OF_LICENSES>20</COUNT_OF_LICENSES>
            </TDXItem>
        </LICENSE>
    </TDXItem>
</GetLicenseConsumption>

See Also

SAapi Object  | SAapi Members