GET api/v1/Locks
Returns lock list
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of LockName | 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
[ { "ClockInstalled": true, "ClockInstalledDateUtc": "2025-07-06T18:12:51.4475918+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": "b436a207-0a60-4216-92c4-074e59869af4", "LockingObject": "sample string 15", "LockType": 16, "Mounting": "sample string 17", "NetworkModuleDevice_ID": "0d5a3893-c915-4afd-b52f-c0b225101f6d", "OtherEquipment": "sample string 18", "PhysicalState": 19, "RealEstate_Id": "0d0a6058-ea6a-4b29-91ec-b7520edb0e1a", "Stamp": "sample string 21", "Zone_ID": "6b0d248c-25a9-4f0f-a23a-f60db01bc908", "DataVersion": 22, "DefaultProgramStationFProgKey_ID": "97eb558c-3d58-420c-ab12-b18c057f2655", "HwVersion": 23, "FloorPlan_ID": "18ff92ea-4e2a-40ca-8d46-f07b3aac9d41", "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 }, { "ClockInstalled": true, "ClockInstalledDateUtc": "2025-07-06T18:12:51.4475918+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": "b436a207-0a60-4216-92c4-074e59869af4", "LockingObject": "sample string 15", "LockType": 16, "Mounting": "sample string 17", "NetworkModuleDevice_ID": "0d5a3893-c915-4afd-b52f-c0b225101f6d", "OtherEquipment": "sample string 18", "PhysicalState": 19, "RealEstate_Id": "0d0a6058-ea6a-4b29-91ec-b7520edb0e1a", "Stamp": "sample string 21", "Zone_ID": "6b0d248c-25a9-4f0f-a23a-f60db01bc908", "DataVersion": 22, "DefaultProgramStationFProgKey_ID": "97eb558c-3d58-420c-ab12-b18c057f2655", "HwVersion": 23, "FloorPlan_ID": "18ff92ea-4e2a-40ca-8d46-f07b3aac9d41", "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
<ArrayOfLock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus"> <Lock> <ClockInstalled>true</ClockInstalled> <ClockInstalledDateUtc>2025-07-06T18:12:51.4475918+03:00</ClockInstalledDateUtc> <DataVersion>22</DataVersion> <DefaultProgramStationFProgKey_ID>97eb558c-3d58-420c-ab12-b18c057f2655</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>b436a207-0a60-4216-92c4-074e59869af4</FLock_ID> <FloorPlanPointX>24.1</FloorPlanPointX> <FloorPlanPointY>25.1</FloorPlanPointY> <FloorPlan_ID>18ff92ea-4e2a-40ca-8d46-f07b3aac9d41</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>0d5a3893-c915-4afd-b52f-c0b225101f6d</NetworkModuleDevice_ID> <OtherEquipment>sample string 18</OtherEquipment> <PhysicalState>19</PhysicalState> <RealEstate_Id>0d0a6058-ea6a-4b29-91ec-b7520edb0e1a</RealEstate_Id> <Secret>sample string 32</Secret> <SerialNumber>33</SerialNumber> <Stamp>sample string 21</Stamp> <SwVersion>34</SwVersion> <Zone_ID>6b0d248c-25a9-4f0f-a23a-f60db01bc908</Zone_ID> </Lock> <Lock> <ClockInstalled>true</ClockInstalled> <ClockInstalledDateUtc>2025-07-06T18:12:51.4475918+03:00</ClockInstalledDateUtc> <DataVersion>22</DataVersion> <DefaultProgramStationFProgKey_ID>97eb558c-3d58-420c-ab12-b18c057f2655</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>b436a207-0a60-4216-92c4-074e59869af4</FLock_ID> <FloorPlanPointX>24.1</FloorPlanPointX> <FloorPlanPointY>25.1</FloorPlanPointY> <FloorPlan_ID>18ff92ea-4e2a-40ca-8d46-f07b3aac9d41</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>0d5a3893-c915-4afd-b52f-c0b225101f6d</NetworkModuleDevice_ID> <OtherEquipment>sample string 18</OtherEquipment> <PhysicalState>19</PhysicalState> <RealEstate_Id>0d0a6058-ea6a-4b29-91ec-b7520edb0e1a</RealEstate_Id> <Secret>sample string 32</Secret> <SerialNumber>33</SerialNumber> <Stamp>sample string 21</Stamp> <SwVersion>34</SwVersion> <Zone_ID>6b0d248c-25a9-4f0f-a23a-f60db01bc908</Zone_ID> </Lock> </ArrayOfLock>