Get hardware(s) on IQ

This endpoint shows the current tree structure of the IQ (hardware attached to a specific IQ).

What is an IQ? Check out our Glossary.

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Endpoint: "/v1.1/sites/{site_id}/iqs/{id}/tree"
Method: GET

Parameters:
Path {
site_id;
type: string, format: uuid;
required

Id of the site

site_id
}(string) Path {
id;
type: string, format: uuid;
required

Id of the IQ

id
}(string)
Response Content Type (application/json):
[
  {
    
mac;
type: string

The mac adress of the hardware (lock|repeater)

"mac"
: "string",
customer_reference;
type: string

The name/reference given to the hardware by the client

"customer_reference"
: "string",
lock_type;
type: string
enumeration: [none, unknown, escutcheon, cylinder, wall_reader, escutcheon_pin, wall_reader_pin];

The lock type of the hardware

"lock_type"
: "string",
is_online;
type: boolean

If the hardware is online

"is_online"
: boolean,
is_attached;
type: boolean

If the hardware is attached

"is_attached"
: boolean,
battery_state;
type: string
enumeration: [critical, low, good, fresh, none, unknown];

The battery state of the hardware

"battery_state"
: "string",
communication_type;
type: string
enumeration: [rf_net, blue_net];

The communication type of the hardware

"communication_type"
: "string",
id;
type: string, format: uuid;

The id of the hardware (lock|repeater)

"id"
: "string",
parent_id;
type: string, format: uuid;

The id of the parent HW

"parent_id"
: "string",
hardware_type;
type: string
enumeration: [lock, repeater];

The type of the hardware

"hardware_type"
: "string" } ]