GET api/v1/Locks

Returns lock list

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Lock
NameDescriptionTypeAdditional 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-20T14:24:37.1142875+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": "9f7825a0-eef9-4f1e-98e4-c393b8d6443b",
    "LockingObject": "sample string 15",
    "LockType": 16,
    "Mounting": "sample string 17",
    "NetworkModuleDevice_ID": "50497e74-56fd-4b46-b6dd-2e07f52240ee",
    "OtherEquipment": "sample string 18",
    "PhysicalState": 19,
    "RealEstate_Id": "d22483a3-de49-426b-b65d-b192e115c480",
    "Stamp": "sample string 21",
    "Zone_ID": "b8e76afe-0186-4bfa-92b2-947182fe15c8",
    "DataVersion": 22,
    "DefaultProgramStationFProgKey_ID": "3d5ca684-5755-491c-a922-63b37bfaa45b",
    "HwVersion": 23,
    "FloorPlan_ID": "e3b2307d-944b-4bed-b369-3fab89430bef",
    "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-05-20T14:24:37.1142875+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": "9f7825a0-eef9-4f1e-98e4-c393b8d6443b",
    "LockingObject": "sample string 15",
    "LockType": 16,
    "Mounting": "sample string 17",
    "NetworkModuleDevice_ID": "50497e74-56fd-4b46-b6dd-2e07f52240ee",
    "OtherEquipment": "sample string 18",
    "PhysicalState": 19,
    "RealEstate_Id": "d22483a3-de49-426b-b65d-b192e115c480",
    "Stamp": "sample string 21",
    "Zone_ID": "b8e76afe-0186-4bfa-92b2-947182fe15c8",
    "DataVersion": 22,
    "DefaultProgramStationFProgKey_ID": "3d5ca684-5755-491c-a922-63b37bfaa45b",
    "HwVersion": 23,
    "FloorPlan_ID": "e3b2307d-944b-4bed-b369-3fab89430bef",
    "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: 
<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-05-20T14:24:37.1142875+03:00</ClockInstalledDateUtc>
    <DataVersion>22</DataVersion>
    <DefaultProgramStationFProgKey_ID>3d5ca684-5755-491c-a922-63b37bfaa45b</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>9f7825a0-eef9-4f1e-98e4-c393b8d6443b</FLock_ID>
    <FloorPlanPointX>24.1</FloorPlanPointX>
    <FloorPlanPointY>25.1</FloorPlanPointY>
    <FloorPlan_ID>e3b2307d-944b-4bed-b369-3fab89430bef</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>50497e74-56fd-4b46-b6dd-2e07f52240ee</NetworkModuleDevice_ID>
    <OtherEquipment>sample string 18</OtherEquipment>
    <PhysicalState>19</PhysicalState>
    <RealEstate_Id>d22483a3-de49-426b-b65d-b192e115c480</RealEstate_Id>
    <Secret>sample string 32</Secret>
    <SerialNumber>33</SerialNumber>
    <Stamp>sample string 21</Stamp>
    <SwVersion>34</SwVersion>
    <Zone_ID>b8e76afe-0186-4bfa-92b2-947182fe15c8</Zone_ID>
  </Lock>
  <Lock>
    <ClockInstalled>true</ClockInstalled>
    <ClockInstalledDateUtc>2025-05-20T14:24:37.1142875+03:00</ClockInstalledDateUtc>
    <DataVersion>22</DataVersion>
    <DefaultProgramStationFProgKey_ID>3d5ca684-5755-491c-a922-63b37bfaa45b</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>9f7825a0-eef9-4f1e-98e4-c393b8d6443b</FLock_ID>
    <FloorPlanPointX>24.1</FloorPlanPointX>
    <FloorPlanPointY>25.1</FloorPlanPointY>
    <FloorPlan_ID>e3b2307d-944b-4bed-b369-3fab89430bef</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>50497e74-56fd-4b46-b6dd-2e07f52240ee</NetworkModuleDevice_ID>
    <OtherEquipment>sample string 18</OtherEquipment>
    <PhysicalState>19</PhysicalState>
    <RealEstate_Id>d22483a3-de49-426b-b65d-b192e115c480</RealEstate_Id>
    <Secret>sample string 32</Secret>
    <SerialNumber>33</SerialNumber>
    <Stamp>sample string 21</Stamp>
    <SwVersion>34</SwVersion>
    <Zone_ID>b8e76afe-0186-4bfa-92b2-947182fe15c8</Zone_ID>
  </Lock>
</ArrayOfLock>