Listing Devices at Client

Base URL

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

Description

Lists all devices of type 'server/workstation' for a client.

Note: Default ordering first by sitename then by devicename.

Parameters

Required parameters

Add required parameters immediately after the base URL.

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

Parameter	Description	Type	Options	Default
clientid	he clientid must be a valid id.	integer	0	0
devicetype	The devicetype is optional but if used should be either "server" or "workstation" or "mobile_device".	string	server workstation mobile_device	Server

Optional parameters

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

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

List devices at client for servers

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_devices_at_client&clientid=CLIENTID&devicetype=server

Example response

<?xml version="1.0"?>
<result created="2015-07-20T08T08:47:41+01:00" host="SERVER" status="OK">
  <items>
    <client>
      <id>30000077</id>
      <name>TestClient</name>
        <site>
          <id>30000083</id>
          <name>TestSite</name>
          <server>
            <id>30000192</id>
            <name>SERVER</name>
            <username>Company\Administrator</username>
            <description>Dashboard Description</description>
            <status>Ok</status>
            <checkcount>
              <dsc_247>1</dsc_247>
              <pass>3</pass>
              <clear>4</clear>
              <fail>5</fail>
            </checkcount>
            ..... more checkcount nodes (3 total with different content of dsc_247 node)
<takecontrol>1</takecontrol> 
<patch>0</patch> 
<mav>1</mav> 
<mob>1</mob> 
<systray>1</systray>
<mavbreck>0</mavbreck>
</server>
          ..... more nodes
        </site>
      ..... more site nodes
    </client>
  </items>
</result>

List devices at client for workstations

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_devices_at_client&clientid=CLIENTID&devicetype=workstation

Example response

<?xml version="1.0"?>
<result created="2015-07-20T08:47:41+01:00" host="SERVER" status="OK">
  <items>
    <client>
      <id>30000077</id>
      <name>TestClient</name>
        <site>
          <id>30000083</id>
          <name>TestSite</name>
          <workstation>
            <id>30000302</id>
            <name>WORKSTATION</name>
            <username>Company\User</username>
            <description>Dashboard Description</description>
            <status>offline</status>
            <checkcount>
              <dsc_247>1</dsc_247>
              <pass>3</pass>
              <clear>4</clear>
              <fail>5</fail>
            </checkcount>
            ..... more checkcount nodes (3 total with different content of dsc_247 node)
<takecontrol>1</takecontrol> 
<patch>0</patch> 
<mav>1</mav> 
<mob>1</mob> 
<systray>1</systray>
<mavbreck>0</mavbreck>
</workstation>
          ..... more nodes
        </site>
      ..... more site nodes
    </client>
  </items>
</result>

List devices at client for mobile devices

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_devices_at_client&clientid=CLIENTID&devicetype=mobile_device

Example response

<?xml version="1.0"?>
<result created="2015-07-20T08:47:41+01:00" host="SERVER" status="OK">
  <items>
    <client>
      <id>30000077</id>
      <name>TestClient</name>
        <site>
          <id>30000083</id>
          <name>TestSite</name>
          <mobile_device>
            <id>300251</id>
            <name>MOBILE</name>
<policy_type>cod</policy_type>
</mobile_device>
          ..... more nodes
        </site>
      ..... more site nodes
    </client>
  </items>
</result>

Returned fields

Field	Type	Can Be Empty	Description
client / id	integer	no	Unique identifier of client
client / name	string	yes	Name of client
site / id	integer	no	Unique identifier of site
site / name	string	yes	Name of site
device / id	integer	no	Unique identifier of device, workstation or server
device / name	string	yes	Name of device
device / username	string	yes	Logged on user
device / description	string	yes	Device's Dashboard description
device / status	string	no	Status of device: "ok" "error" "inactive" "ispdownown" "overdue" "offline" (workstations only) "maintenance" (servers only)
device / checkcount/dsc_247	integer	no	Check types of the counts given below this note: 2: Daily Safety Check 1: 24x7 Check 3: Scheduled Task
device / checkcount/pass	integer	no	Number of tests passing
device / checkcount/fail	integer	no	Number of tests failing
device / checkcount/clear	integer	no	Number of tests cleared
device / takecontrol	integer (1 or 0)	no	Is Take Control installed and active: 0: No 1: Yes
device / patch	integer (1 or 0)	no	Is Patch Management installed and active: 0: No 1: Yes
device / mav	integer (1 or 0)	no	Is Managed Anti-virus (VIPRE Engine) installed and active: 0: No 1: Yes
device / mob	integer (1 or 0)	no	Is Managed Backup installed and active: 0: No 1: Yes
device / systray	integer (1 or 0)	no	Is System Tray installed and active: 0: No 1: Yes
device / mavbreck	integer (1 or 0)	no	Is Managed Anti-virus (Bitdefender Engine) installed and active: 0: No 1: Yes
device / webprotection	integer (1 or 0)	no	Is Web Protection installed and active: 0: No 1: Yes
device / riskintelligence	integer (1 or 0)	no	Is Risk Intelligence installed and active: 0: No 1: Yes
mobile_device / policy_type	string	no	Type of mobile device management policy applied to the device: cod: Company Owned Device byod: Employee owned device ("Bring Your Own Device")