Add tags

This endpoint allows to add tags, which are contactless key fobs.

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}/locks/{id}/tag_registration"
Method: PATCH

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 lock

id
}(string) Body (application/json): {
duration_in_seconds;
type: integer, format: int32;

Tag registration duration in seconds

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

id of the lock

"id"
: "string",
customer_reference;
type: string

Name of the lock

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

The mac address of the lock

"mac"
: "string",
locked_state;
type: string

Indicates the state of the lock

"locked_state"
: "string",
lock_type;
type: string

Indicates the type of the lock

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

Indicates if the lock is connected to the iq

"online"
: boolean,
iq_link_state;
type: string

Indicates the state of the lock's connection setup with the IQ

"iq_link_state"
: "string",
tag_registration_state;
type: string

Indicates if the lock is in tag registration mode

"tag_registration_state"
: "string",
battery_level;
type: string
enumeration: [critical, low, good, fresh, none, unknown];

The battery level of the lock.

"battery_level"
: "string",
left_open_alarm;
type: boolean

Indicates if the door is left open. Applicable for escutcheons with a DLO feature.

"left_open_alarm"
: boolean,
intrusion_alarm;
type: boolean

Indicates if an intrusion alarm is active.

"intrusion_alarm"
: boolean,
easy_office_mode_schedule;

EOM schedule

"easy_office_mode_schedule"
: [ {
monday;
type: boolean

TimeSchedule enabled on monday flag, set to true if enabled

"monday"
: boolean,
tuesday;
type: boolean

TimeSchedule enabled on tuesday flag, set to true if enabled

"tuesday"
: boolean,
wednesday;
type: boolean

TimeSchedule enabled on wednesday flag, set to true if enabled

"wednesday"
: boolean,
thursday;
type: boolean

TimeSchedule enabled on thursday flag, set to true if enabled

"thursday"
: boolean,
friday;
type: boolean

TimeSchedule enabled on friday flag, set to true if enabled

"friday"
: boolean,
saturday;
type: boolean

TimeSchedule enabled on saturday flag, set to true if enabled

"saturday"
: boolean,
sunday;
type: boolean

TimeSchedule enabled on sunday flag, set to true if enabled

"sunday"
: boolean,
start_time;
type: string

TimeSchedule start time

"start_time"
: "string",
end_time;
type: string

TimeSchedule end time

"end_time"
: "string",
start_date;
type: string, format: date-time;

TimeSchedule start date

"start_date"
: "string",
end_date;
type: string, format: date-time;

TimeSchedule end date

"end_date"
: "string" } ],
iq;

The iq this lock is attached to

"iq"
: [ {
mac_address;
type: string

Mac address of the IQ

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

Is IQ online or not

"is_online"
: boolean,
revision;
type: string

Iq version

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

id of the IQ

"id"
: "string",
customer_reference;
type: string

Name of the IQ

"customer_reference"
: "string" } ],
repeater;

The repeater this lock is attached to

"repeater"
: [ {
id;
type: string, format: uuid;

id of the repeater

"id"
: "string",
customer_reference;
type: string

Name of the repeater

"customer_reference"
: "string" } ],
privacy_mode;
type: boolean

Indicates if locks privacy mode is enabled

"privacy_mode"
: boolean,
communication_type;
type: string

The communication type of the lock

"communication_type"
: "string" }