Get Newbies Information

Request Parameters

Parameter

Description

Obligatory

id

Station identifier.

This parameter can be defined in the request several times to get information on a several stations at a time.

yes

 

Request Example

http://192.168.1.1:9080/api/stations/newbies-info.ds?id=d034621d-7405-e711-1491-f4600dec4700

XML and JSON response structure examples are described below.

 

XML Response

<drweb-es-api api_version="<%API_V%>" timestamp="1558521955" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <stations total="1">
    <station id="d034621d-7405-e711-1491-f4600dec4700" name="36fz1ya27aQ" created="1489138192" parent_id="20e27d73-d21d-b211-a788-85419c46f0e6" parent_name="Everyone" state="0">
        <os code="35850244">Windows 7 Enterprise x64</os>

        <server>70d9cc8c-6df7-e611-1c76-f030d2090f68</server>

        <address>tcp://192.168.1.1:57516</address>
    </station>
  </stations>
</drweb-es-api>

 

Description of XML Response Parameters

The <stations /> element contains information on newbies stations.

The <stations /> element attribute:

Attribute

Description

total

Total number of stations information on which is displayed in response

The <station /> element contains information on a specific newbie station.

The <station /> element attributes:

Attribute

Description

id

Station ID

name

Station name

created

Date of account creation at the Server

parent_id

Parent group identifier

parent_name

Parent group name

state

The current state of the station (see Returned station state codes)

The <os /> element contains information about the operating system currently installed on the station.

The <os /> element attribute:

Attribute

Description

code

Operating system code

The <os /> element value is an operating system name.

The <server /> element value is identifier of Server to which the station requests a connection.

The <address /> element value is a network address from which the station accessed the Server at the last time.

 

JSON Response

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

    "timestamp": 1558522043,

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

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

      "version": "12.00.0.201909260",
      "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

"data": {
    "total": 1,

    "list": [{
      "address": "tcp://192.168.1.1:40566",

      "created_time": 1489138192,

      "id": "1a299c6c-5b5c-4089-a72b-3044752d52b7",

      "name": "elena.i.drweb.ru",

      "onconnect": 2,

      "os_code": 16842752,

      "os_name": "Linux",

      "parent_id": "20e27d73-d21d-b211-a788-85419c46f0e6",

      "parent_name": "Everyone",

      "server": "257f112d-ab07-4d17-ae01-f37b6b135fab",
      "state": 0}]}}

 

Description of JSON Response Parameters

The data block contains information on all newbie stations.

The data block elements:

Field name

Description

total

Total number of stations information on which is displayed in response

The list array contains information on specific newbies stations.

Elements in the list array:

Field name

Description

address

Network address from which the station accessed the Server at the last time

created_time

Date of account creation at the Server

id

Station ID

name

Station name

onconnect

Action that will be performed on the next connection of a station to the Server:

0—perform nothing,

1—access to the Server for a newbie will be denied,

2—access to the Server for a newbie will be granted.

os_code

Operating system code

os_name

Operating system name

parent_id

Parent group identifier

parent_name

Parent group name

server

Identifier of Server to which the station requests a connection

state

The current state of the station (see Returned station state codes)