GET api/v1/Locks/{id}

Returns single lock

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Lock

Name	Description	Type	Additional information
ClockInstalled	Is clock installed on physical lock	boolean	None.
ClockInstalledDateUtc	UTC date when the clock was installed if ClockInstalled = true. Null if information isn't available	date (nullable)	None.
Description	Lock's description	string	None.
Direction	Door's opening direction	string	None.
DoorThickness	Door's thickness	string	None.
DoorType	Door's type	string	None.
Ext	Ext	integer	None.
ExtDescription	Description of Ext	string	None.
ExtentionPiece	Extension piece	string	None.
Handed	Door's handiness	string	None.
KeyChamber	Lock's key chamber type	string	None.
LocationCode	Location code	string	None.
LockFramework	Lock framework	string	None.
LockFrameworkDepth	Lock framework depth	string	None.
FLock_ID	Lock's unique identifier	globally unique identifier	None.
LockingObject	Locking object	string	None.
LockType	Lock type	integer	None.
Mounting	Mounting	string	None.
NetworkModuleDevice_ID	Unique identifier for network module device if lock is connected to one.	globally unique identifier (nullable)	None.
OtherEquipment	Other equipment	string	None.
PhysicalState	Lock's physical state	integer	None.
RealEstate_Id	RealEstate Id	globally unique identifier	None.
Stamp	Stamp	string	None.
Zone_ID	Zone Id	globally unique identifier (nullable)	None.
DataVersion	Data version	integer	None.
DefaultProgramStationFProgKey_ID	Default program station id if available.	globally unique identifier (nullable)	None.
HwVersion	Hardware version	integer	None.
FloorPlan_ID	Floor plan ID if lock is used in floor plan	globally unique identifier (nullable)	None.
FloorPlanPointX	X coordinate on floor plan.	decimal number	None.
FloorPlanPointY	Y coordinate on floor plan	decimal number	None.
LockCode	Lock code	string	None.
LockSettings	Lock settings	string	None.
LockState	Lock state	integer	None.
MAC	MAC address	string	None.
ManufacturingInfo	Manufacturing info	string	None.
MechVersion	Mech version	integer	None.
Secret	Lock secret	string	None.
SerialNumber	Lock serial number	integer	None.
SwVersion	Lock software version	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ClockInstalled": true,
  "ClockInstalledDateUtc": "2025-05-20T13:18:43.0536945+03:00",
  "Description": "sample string 2",
  "Direction": "sample string 3",
  "DoorThickness": "sample string 4",
  "DoorType": "sample string 5",
  "Ext": 6,
  "ExtDescription": "sample string 7",
  "ExtentionPiece": "sample string 8",
  "Handed": "sample string 9",
  "KeyChamber": "sample string 10",
  "LocationCode": "sample string 11",
  "LockFramework": "sample string 12",
  "LockFrameworkDepth": "sample string 13",
  "FLock_ID": "f7698077-7954-4fac-b657-8d4f69834314",
  "LockingObject": "sample string 15",
  "LockType": 16,
  "Mounting": "sample string 17",
  "NetworkModuleDevice_ID": "83752e6a-9312-42f1-b1a6-611a70eb1273",
  "OtherEquipment": "sample string 18",
  "PhysicalState": 19,
  "RealEstate_Id": "08d3b857-0b92-4445-972f-4b6a096bd669",
  "Stamp": "sample string 21",
  "Zone_ID": "209cc627-f9b4-4783-a5b4-52bf3936d37c",
  "DataVersion": 22,
  "DefaultProgramStationFProgKey_ID": "32ec452f-f4b7-49b1-a5a6-eb63b0f66e9c",
  "HwVersion": 23,
  "FloorPlan_ID": "aba4949f-e498-4672-8ddd-acc9b075ad0a",
  "FloorPlanPointX": 24.1,
  "FloorPlanPointY": 25.1,
  "LockCode": "sample string 26",
  "LockSettings": "sample string 27",
  "LockState": 28,
  "MAC": "sample string 29",
  "ManufacturingInfo": "sample string 30",
  "MechVersion": 31,
  "Secret": "sample string 32",
  "SerialNumber": 33,
  "SwVersion": 34
}

application/xml, text/xml

Sample:

<Lock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
  <ClockInstalled>true</ClockInstalled>
  <ClockInstalledDateUtc>2025-05-20T13:18:43.0536945+03:00</ClockInstalledDateUtc>
  <DataVersion>22</DataVersion>
  <DefaultProgramStationFProgKey_ID>32ec452f-f4b7-49b1-a5a6-eb63b0f66e9c</DefaultProgramStationFProgKey_ID>
  <Description>sample string 2</Description>
  <Direction>sample string 3</Direction>
  <DoorThickness>sample string 4</DoorThickness>
  <DoorType>sample string 5</DoorType>
  <Ext>6</Ext>
  <ExtDescription>sample string 7</ExtDescription>
  <ExtentionPiece>sample string 8</ExtentionPiece>
  <FLock_ID>f7698077-7954-4fac-b657-8d4f69834314</FLock_ID>
  <FloorPlanPointX>24.1</FloorPlanPointX>
  <FloorPlanPointY>25.1</FloorPlanPointY>
  <FloorPlan_ID>aba4949f-e498-4672-8ddd-acc9b075ad0a</FloorPlan_ID>
  <Handed>sample string 9</Handed>
  <HwVersion>23</HwVersion>
  <KeyChamber>sample string 10</KeyChamber>
  <LocationCode>sample string 11</LocationCode>
  <LockCode>sample string 26</LockCode>
  <LockFramework>sample string 12</LockFramework>
  <LockFrameworkDepth>sample string 13</LockFrameworkDepth>
  <LockSettings>sample string 27</LockSettings>
  <LockState>28</LockState>
  <LockType>16</LockType>
  <LockingObject>sample string 15</LockingObject>
  <MAC>sample string 29</MAC>
  <ManufacturingInfo>sample string 30</ManufacturingInfo>
  <MechVersion>31</MechVersion>
  <Mounting>sample string 17</Mounting>
  <NetworkModuleDevice_ID>83752e6a-9312-42f1-b1a6-611a70eb1273</NetworkModuleDevice_ID>
  <OtherEquipment>sample string 18</OtherEquipment>
  <PhysicalState>19</PhysicalState>
  <RealEstate_Id>08d3b857-0b92-4445-972f-4b6a096bd669</RealEstate_Id>
  <Secret>sample string 32</Secret>
  <SerialNumber>33</SerialNumber>
  <Stamp>sample string 21</Stamp>
  <SwVersion>34</SwVersion>
  <Zone_ID>209cc627-f9b4-4783-a5b4-52bf3936d37c</Zone_ID>
</Lock>