Listing Client License Count

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_client_license_count

Description

Lists all client license counts.

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_client_license_count&required_parameters={parameter-value}

Parameter	Description	Type	Options	Default
clientid	The clientid must be a valid id.	integer	0	0

Optional parameters

Add optional parameters after the required parameters in the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_client_license_count&required_parameters={parameter-value}&optional_parameters={parameter-value}

Parameter	Description	Type	Options	Default
describe	Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions.	boolean	true	0

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
clientid	list_clients	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_clients

Examples

Client License count

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_client_license_count&clientid=CLIENTID

Example response

<?xml version="1.0"?>
<result created="2024-10-01T15:20:26+01:00" host="SERVER" status="OK">
  <items>
    <license_count>
      <name>Adobe Acrobat</name>
      <count>3</count>
      <license_count_id>830</license_count_id>
      <swgrpid>409</swgrpid>
      <installed>6</installed>
    </license_count>
    <license_count>
      <name>Advanced Monitoring Agent</name>
      <count>5</count>
      <license_count_id>695</license_count_id>
      <swgrpid>6</swgrpid>
      <installed>4</installed>
    </license_count>
    <!-- more <license_count> nodes -->
  </items>
</result>

Returned fields

Field	Type	Can Be Empty	Description
license_count_id	integer	no	The unique identifier of this license count
swgrpid	string	no	The unique identifier of the software license group
name	string	yes	The name of the software license group
count	string	no	The number
installed	integer	no	The number of software licenses this client is using