POST api/v1/Locks

Adds new lock

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Lock	Lock information	LockInsert	None.
SecurityAccesses	Security accesses which are set for the new lock	Collection of LockSecurityAccessInsert	None.
TimeLimit	Time limit information for the new lock	LockTimeLimit	None.
LockRelay	Lock relay information	LockRelay	None.

Request Formats

application/json, text/json

Sample:

{
  "Lock": {
    "FLock_ID": "5d23a79a-63dc-4317-a202-4390a7212ab2",
    "ClockInstalled": true,
    "ClockInstalledDateUtc": "2025-05-20T14:45:12.1552462+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",
    "LockingObject": "sample string 14",
    "LockType": 15,
    "Mounting": "sample string 16",
    "OtherEquipment": "sample string 17",
    "RealEstate_Id": "20af06c2-6e05-4b3b-b29d-9864824a9633",
    "Stamp": "sample string 19",
    "Zone_ID": "80293ec8-ea5d-4c62-a611-055eb43575e0",
    "DataVersion": 20,
    "DefaultProgramStationFProgKey_ID": "0a46e64e-aedd-4495-8c9d-f8b7b7f37ecf",
    "HwVersion": 21,
    "FloorPlan_ID": "c669640c-6b26-416d-88d5-829f262a8a03",
    "FloorPlanPointX": 22.1,
    "FloorPlanPointY": 23.1,
    "LockCode": "sample string 24",
    "LockSettings": "sample string 25",
    "ManufacturingInfo": "sample string 26",
    "MechVersion": 27,
    "Secret": "sample string 28",
    "SerialNumber": 29,
    "SwVersion": 30
  },
  "SecurityAccesses": [
    {
      "RelayMask": 1,
      "SecurityAccess_ID": "5671d1ba-2889-4ec3-9b9b-2098924596c3"
    },
    {
      "RelayMask": 1,
      "SecurityAccess_ID": "5671d1ba-2889-4ec3-9b9b-2098924596c3"
    }
  ],
  "TimeLimit": {
    "HighSecurity": true,
    "TimeLimitMask": 2
  },
  "LockRelay": {
    "RelayK1Delay": 1,
    "RelayK2Delay": 2,
    "RelayMask": 3,
    "RelayMode": 4,
    "RelayNameData": "sample string 5",
    "RelayPacket": true,
    "RelayQuasarDelay": 7,
    "RelayQuasarMode": 8
  }
}

application/xml, text/xml

Sample:

<LockParams.InsertLockParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.ws.WebApi.Params">
  <Lock xmlns:d2p1="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
    <d2p1:ClockInstalled>true</d2p1:ClockInstalled>
    <d2p1:ClockInstalledDateUtc>2025-05-20T14:45:12.1552462+03:00</d2p1:ClockInstalledDateUtc>
    <d2p1:DataVersion>20</d2p1:DataVersion>
    <d2p1:DefaultProgramStationFProgKey_ID>0a46e64e-aedd-4495-8c9d-f8b7b7f37ecf</d2p1:DefaultProgramStationFProgKey_ID>
    <d2p1:Description>sample string 2</d2p1:Description>
    <d2p1:Direction>sample string 3</d2p1:Direction>
    <d2p1:DoorThickness>sample string 4</d2p1:DoorThickness>
    <d2p1:DoorType>sample string 5</d2p1:DoorType>
    <d2p1:Ext>6</d2p1:Ext>
    <d2p1:ExtDescription>sample string 7</d2p1:ExtDescription>
    <d2p1:ExtentionPiece>sample string 8</d2p1:ExtentionPiece>
    <d2p1:FLock_ID>5d23a79a-63dc-4317-a202-4390a7212ab2</d2p1:FLock_ID>
    <d2p1:FloorPlanPointX>22.1</d2p1:FloorPlanPointX>
    <d2p1:FloorPlanPointY>23.1</d2p1:FloorPlanPointY>
    <d2p1:FloorPlan_ID>c669640c-6b26-416d-88d5-829f262a8a03</d2p1:FloorPlan_ID>
    <d2p1:Handed>sample string 9</d2p1:Handed>
    <d2p1:HwVersion>21</d2p1:HwVersion>
    <d2p1:KeyChamber>sample string 10</d2p1:KeyChamber>
    <d2p1:LocationCode>sample string 11</d2p1:LocationCode>
    <d2p1:LockCode>sample string 24</d2p1:LockCode>
    <d2p1:LockFramework>sample string 12</d2p1:LockFramework>
    <d2p1:LockFrameworkDepth>sample string 13</d2p1:LockFrameworkDepth>
    <d2p1:LockSettings>sample string 25</d2p1:LockSettings>
    <d2p1:LockType>15</d2p1:LockType>
    <d2p1:LockingObject>sample string 14</d2p1:LockingObject>
    <d2p1:ManufacturingInfo>sample string 26</d2p1:ManufacturingInfo>
    <d2p1:MechVersion>27</d2p1:MechVersion>
    <d2p1:Mounting>sample string 16</d2p1:Mounting>
    <d2p1:OtherEquipment>sample string 17</d2p1:OtherEquipment>
    <d2p1:RealEstate_Id>20af06c2-6e05-4b3b-b29d-9864824a9633</d2p1:RealEstate_Id>
    <d2p1:Secret>sample string 28</d2p1:Secret>
    <d2p1:SerialNumber>29</d2p1:SerialNumber>
    <d2p1:Stamp>sample string 19</d2p1:Stamp>
    <d2p1:SwVersion>30</d2p1:SwVersion>
    <d2p1:Zone_ID>80293ec8-ea5d-4c62-a611-055eb43575e0</d2p1:Zone_ID>
  </Lock>
  <LockRelay xmlns:d2p1="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
    <d2p1:RelayK1Delay>1</d2p1:RelayK1Delay>
    <d2p1:RelayK2Delay>2</d2p1:RelayK2Delay>
    <d2p1:RelayMask>3</d2p1:RelayMask>
    <d2p1:RelayMode>4</d2p1:RelayMode>
    <d2p1:RelayNameData>sample string 5</d2p1:RelayNameData>
    <d2p1:RelayPacket>true</d2p1:RelayPacket>
    <d2p1:RelayQuasarDelay>7</d2p1:RelayQuasarDelay>
    <d2p1:RelayQuasarMode>8</d2p1:RelayQuasarMode>
  </LockRelay>
  <SecurityAccesses xmlns:d2p1="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
    <d2p1:LockSecurityAccessInsert>
      <d2p1:RelayMask>1</d2p1:RelayMask>
      <d2p1:SecurityAccess_ID>5671d1ba-2889-4ec3-9b9b-2098924596c3</d2p1:SecurityAccess_ID>
    </d2p1:LockSecurityAccessInsert>
    <d2p1:LockSecurityAccessInsert>
      <d2p1:RelayMask>1</d2p1:RelayMask>
      <d2p1:SecurityAccess_ID>5671d1ba-2889-4ec3-9b9b-2098924596c3</d2p1:SecurityAccess_ID>
    </d2p1:LockSecurityAccessInsert>
  </SecurityAccesses>
  <TimeLimit xmlns:d2p1="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
    <d2p1:HighSecurity>true</d2p1:HighSecurity>
    <d2p1:TimeLimitMask>2</d2p1:TimeLimitMask>
  </TimeLimit>
</LockParams.InsertLockParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.