Endpoint: "/v1.1/sites/{site_id}/locks/{id}/detach"
Method: PATCH
Parameters:
Path {site_id;
type: string, format: uuid;
requiredId of the site
site_id}(string)
Path {id;
type: string, format: uuid;
requiredId of the lock
id}(string)
Body (application/json):
{
iq_link_state;
type: string
enumeration: [attached_pending, attached, detached, detached_pending];The state of the Lock - Iq link, used to detach a lock
"iq_link_state" : "string",
otp;
type: stringA valid otp
"otp" : "string"
}
Response Content Type (application/json):
{
id;
type: string, format: uuid;id of the lock
"id" : "string",
customer_reference;
type: stringName of the lock
"customer_reference" : "string",
mac;
type: stringThe mac address of the lock
"mac" : "string",
locked_state;
type: stringIndicates the state of the lock
"locked_state" : "string",
lock_type;
type: stringIndicates the type of the lock
"lock_type" : "string",
online;
type: booleanIndicates if the lock is connected to the iq
"online" : boolean,
iq_link_state;
type: stringIndicates the state of the lock's connection setup with the IQ
"iq_link_state" : "string",
tag_registration_state;
type: stringIndicates 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: booleanIndicates if the door is left open. Applicable for escutcheons with a DLO feature.
"left_open_alarm" : boolean,
intrusion_alarm;
type: booleanIndicates if an intrusion alarm is active.
"intrusion_alarm" : boolean,
easy_office_mode_schedule;
EOM schedule
"easy_office_mode_schedule" : [
{
monday;
type: booleanTimeSchedule enabled on monday flag, set to true if enabled
"monday" : boolean,
tuesday;
type: booleanTimeSchedule enabled on tuesday flag, set to true if enabled
"tuesday" : boolean,
wednesday;
type: booleanTimeSchedule enabled on wednesday flag, set to true if enabled
"wednesday" : boolean,
thursday;
type: booleanTimeSchedule enabled on thursday flag, set to true if enabled
"thursday" : boolean,
friday;
type: booleanTimeSchedule enabled on friday flag, set to true if enabled
"friday" : boolean,
saturday;
type: booleanTimeSchedule enabled on saturday flag, set to true if enabled
"saturday" : boolean,
sunday;
type: booleanTimeSchedule enabled on sunday flag, set to true if enabled
"sunday" : boolean,
start_time;
type: stringTimeSchedule start time
"start_time" : "string",
end_time;
type: stringTimeSchedule 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: stringMac address of the IQ
"mac_address" : "string",
is_online;
type: booleanIs IQ online or not
"is_online" : boolean,
revision;
type: stringIq version
"revision" : "string",
id;
type: string, format: uuid;id of the IQ
"id" : "string",
customer_reference;
type: stringName 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: stringName of the repeater
"customer_reference" : "string"
}
],
privacy_mode;
type: booleanIndicates if locks privacy mode is enabled
"privacy_mode" : boolean,
communication_type;
type: stringThe communication type of the lock
"communication_type" : "string"
}