Add tags

This endpoint allows to add tags, which are the electronic keys.

Use: "tag_registration_duration_in_seconds"

Want to learn more about our Locks? 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/locks/{id}"
Method: PATCH

Parameters:
Path {
id;
type: string, format: uuid;
required
id of the lock
id}(string)
Body (application/json):
{
  
customer_reference;
type: string
The name or any sort of reference that can be used to identify the Lock by the client
"customer_reference" : "string",
  
locked_state;
type: string
enumeration: [none, locked, office_mode, uncertain, unlocked];
The state of the Lock, can be used to remote unlock etc
"locked_state" : "string",
  
iq_link_state;
type: string
enumeration: [attached_pending, attached, detached, detached_pending];
The state of the Lock - Iq link, can be used to detach a lock
"iq_link_state" : "string",
  
tag_registration_duration_in_seconds;
type: integer, format: int32;
The tag registration state of the Lock, can be used to enable the tag registration mode
"tag_registration_duration_in_seconds" : "integer",
  
otp;
type: string
A valid otp
"otp" : "string",
  
accessor_id;
type: string, format: uuid;
The accessor from whom this request originates
"accessor_id" : "string",
  
collection_id;
type: string, format: uuid;
id of the collection
"collection_id" : "string"
}
          
Response Content Type (application/json):
{
  
id;
type: string, format: uuid;
The database id of the lock
"id" : "string",
  
iq;
"iq" : [
    {
      
id;
type: string, format: uuid;
id of the IQ
"id" : "string",
      
customer_reference;
type: string
Name of the IQ
"customer_reference" : "string",
      
mac_address;
type: string
Mac address of the IQ
"mac_address" : "string",
      
is_online;
type: boolean
Is IQ online or not
"is_online" : boolean,
      
collection_id;
type: string, format: uuid;
The id of the collection the IQ is assigned
"collection_id" : "string",
      
revision;
type: string
Iq version
"revision" : "string"
    }
  ],
  
repeater;
"repeater" : [
    {
      
id;
type: string, format: uuid;
The id of the repeater
"id" : "string",
      
customer_reference;
type: string
The name or any sort of reference that can be used to identify the repeater by the client
"customer_reference" : "string",
      
mac_address;
type: string
The mac address of the repeater
"mac_address" : "string",
      
is_online;
type: boolean
Online state
"is_online" : boolean,
      
collection_id;
type: string, format: uuid;
The id of the collection the repeater is assigned
"collection_id" : "string"
    }
  ],
  
mac;
type: string
Mac address
"mac" : "string",
  
customer_reference;
type: string
The name or any sort of reference that can be used to identify the lock by the client
"customer_reference" : "string",
  
locked_state;
type: string
Current state of the lock
"locked_state" : "string",
  
lock_type;
type: string
Lock type
"lock_type" : "string",
  
online;
type: boolean
Online state
"online" : boolean,
  
iq_link_state;
type: string
Iq link state
"iq_link_state" : "string",
  
tag_registration_state;
type: string
Tag registration state
"tag_registration_state" : "string",
  
battery_level;
type: string
enumeration: [none, low, good, fresh];
Battery power level
"battery_level" : "string",
  
left_open_alarm;
type: boolean
ILock left unlocked alarm on
"left_open_alarm" : boolean,
  
intrusion_alarm;
type: boolean
Intrusion alarm on
"intrusion_alarm" : boolean,
  
easy_office_mode_schedule;
easy office mode schedule
"easy_office_mode_schedule" : [
    {
      
monday;
type: boolean
Whether this timeschedule is valid on a Monday between start and end datetimes
"monday" : boolean,
      
tuesday;
type: boolean
Whether this timeschedule is valid on a Tuesday between start and end datetimes
"tuesday" : boolean,
      
wednesday;
type: boolean
Whether this timeschedule is valid on a Wednesday between start and end datetimes
"wednesday" : boolean,
      
thursday;
type: boolean
Whether this timeschedule is valid on a Thursday between start and end datetimes
"thursday" : boolean,
      
friday;
type: boolean
Whether this timeschedule is valid on a Friday between start and end datetimes
"friday" : boolean,
      
saturday;
type: boolean
Whether this timeschedule is valid on a Saturday between start and end datetimes
"saturday" : boolean,
      
sunday;
type: boolean
Whether this timeschedule is valid on a Sunday between start and end datetimes
"sunday" : boolean,
      
start_time;
type: string
The start of the time span on which this timeschedule is valid, for the selected days and date span.
"start_time" : "string",
      
end_time;
type: string
The end of the time span on which this timeschedule is valid, for the selected days and date span.
"end_time" : "string",
      
start_date;
type: string, format: date-time;
The date at which the timeschedule starts beeing valid
"start_date" : "string",
      
end_date;
type: string, format: date-time;
The date at which the timeschedule stops being valid
"end_date" : "string"
    }
  ],
  
collection_id;
type: string, format: uuid;
The id of the collection the lock is assigned
"collection_id" : "string"
}