Get Administrator Group Information

Request Parameter

Parameter

Description

Mandatory

id

Administrator group ID.

This parameter can be repeated any number of times per request to request information about multiple administrator groups at a time.

yes

 

Request Example

https://192.168.1.1:9081/api/admingroups/info.ds?id=adm1&id=adm2

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1588495732" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <admin-groups total="2">
     <admin-group id="adm1" name="Gr-Admin-1" description="Default administrator group" modified="1588334566" parent_group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" parent_group_name="Administrators"/>

     <admin-group id="adm2" name="Gr-Admin-2" description="" modified="1588334256" parent_group_id="777" parent_group_name="NEW-GROUP"/>
  </admin-groups>
</drweb-es-api>

 

Description of XML Response Parameters

The <admin-groups /> element contains information about administrator groups specified in the request.

The <admin-groups /> element attribute:

Attribute

Description

total

Total number of administrator groups in the response

The <admin-group /> element contains parameters of a specific administrator group.

The <admin-group /> element attributes:

Attribute

Description

id

Group ID

name

Group name

description

Group description

modified

Group modification time and date

parent_group_id

Parent administrator group ID

parent_group_name

Parent administrator group name

 

JSON Response Structure

{ "head": {
    "status": true,

    "timestamp": 1588495959,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

    "server": {
      "name": "192.168.1.1",

      "version": "12.00.0.201909260",
      "uuid": "78b77680-8080-11ea-701a-44a527d9115c"}},

"data": {
    "admins": {
      "total": 2,

      "list": [
          {"id": "adm1",

          "description": "Default administrator group",

          "modified_time": 1588334566,

          "name": "Admin-1",

          "parent_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d",
          "parent_name": "Administrators"},

          {"id": "adm2",

          "description": "",

          "modified_time": 1588334513,

          "name": "Admin-2",

          "parent_id": "777",
          "parent_name": "NEW-GROUP"}]}}}

 

Description of JSON Response Parameters

The data block contains information about administrator groups specified in the request.

The data block elements:

Field name

Description

total

Total number of administrator groups in the response

list

Array of parameters for each administrator group

Each object of the list array contains parameters of a specific administrator group.

Elements in the list array:

Field name

Description

id

Group ID

description

Group description

modified_time

Group modification time and date

name

Group name

parent_id

Parent group ID

parent_name

Parent group name