Register IQ

This endpoint allows to add IQs.

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
            
call response
Endpoint: "/v1/iqs"
Method: POST

Parameters:
Body (application/json):
{
  
customer_reference;
type: string

The name or any sort of reference that can be used to identify the IQ by the client

"customer_reference"
: "string",
collection_id;
type: string, format: uuid;

id of the collection

"collection_id"
: "string",
time_zone;
type: string

Timezone of the IQ

"time_zone"
: "string",
activation_code;
type: string

The activation code as written on the physical IQ

"activation_code"
: "string",
subscribed;
type: boolean

If the IQ subscription should be turned on or off

"subscribed"
: boolean }
Response Content Type (application/json):
{
  
id;
type: string, format: uuid;

The database id of the IQ

"id"
: "string",
mac;
type: string

The first 6 digits of the activation code written on the physical IQ

"mac"
: "string",
operator;
type: string

The name of the Operator the IQ is connected to

"operator"
: "string",
state;
type: string

The state of the IQ

"state"
: "string",
restore_required;
type: boolean

If the IQ was reset, restore actions need to be taken - like resetting the tree

"restore_required"
: boolean,
reset_date;
type: string, format: date-time;

The last time stamp when the IQ was reset

"reset_date"
: "string",
online;
type: boolean

The connection state of the IQ to the cloud.

"online"
: boolean,
data_sync_state;
type: string

Shows the local data syncronisation state of the IQ.

"data_sync_state"
: "string",
signal_strength;
type: integer, format: int32;

Shows the mobile network connection strangth of the IQ.

"signal_strength"
: "integer",
collection_id;
type: string, format: uuid;

The id of the collection the IQ is assigned

"collection_id"
: "string",
customer_reference;
type: string

The name or any sort of reference that can be used to identify the IQ by the client

"customer_reference"
: "string",
time_zone;
type: string

Timezone of the IQ

"time_zone"
: "string",
subscribed;
type: boolean

The subscription state of the iq. If changed a command is queued to send to the IQ.

"subscribed"
: boolean,
otp_enabled;
type: boolean

If Enabled secure commands need to use OTPs. Once enabled it cannot be disabled.

"otp_enabled"
: boolean,
led_enabled;
type: boolean

If enabled IQ blinks green every 5 minutes, if not it does not blink

"led_enabled"
: boolean }
Clay Locking Platform logo
Get in touch to learn more about how we can integrate smart locks into your business.