Listing License Group Items

Base URL

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

Description

Lists software in a software license group.

Parameters

Required parameters

Add required parameters immediately after the base URL.

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

Parameter	Description	Type	Options	Default
license_group_id	The license group id. The required license_group_id is referenced in the list_licence_groups call.	integer	yes	0

Parameter

Description

Type

Options

Default

license_group_id

The license group id.

The required license_group_id is referenced in the list_licence_groups call.

integer

yes

Optional parameters

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

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_license_group_items&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
license_group_id	list_license_groups	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_license_group_items

Examples

Lis software in a license group

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_license_group_items&license_group_id=LICENCEGROUPID

Example response

<?xml version="1.0"?>
<result created="2024-10-01T15:08:58+01:00" host="SERVER" status="OK">
  <items>
    <license_group_item>
      <swgrpid>2</swgrpid>
      <count>3</count>
      <license_count_id>41</license_count_id>
    </license_group_item>
  </items>
</result>

Returned fields

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