POST api/v1/Keys

Adds new key

Request Information

URI Parameters

None.

Body Parameters

Parameter

InsertKeyParam
NameDescriptionTypeAdditional information
Key

Key information

 KeyInsert

None.
SecurityAccessIds

Security accesses which should be linked to the new key

 Collection of globally unique identifier

None.
TimeLimits

Time limit information for the new key

 Collection of KeyTimeLimit

None.
ZoneIds

Zones the new key belongs to

 Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "Key": {
    "FNKey_ID": "02e0507e-55e9-4b22-a2b4-47ca92dcaf6d",
    "Description": "sample string 1",
    "ExpireDate": "2025-10-30T06:08:02.7740426+02:00",
    "InfoText": "sample string 2",
    "ManufacturingInfo": "sample string 3",
    "OnlineAccessCode": "sample string 4",
    "Person_ID": "24ce5661-5775-4056-aa11-a7016309c99b",
    "RealEstate_ID": "b7fc2e36-e236-43ef-98a3-e852c51ba05c",
    "ROM_ID": "sample string 6",
    "Stamp": "sample string 7",
    "TagKey": "sample string 8",
    "VersionCode": "sample string 9"
  },
  "SecurityAccessIds": [
    "7a292f4a-2a29-4287-a375-896e71613df8",
    "c8450a33-da7a-42bc-940e-976f5022b790"
  ],
  "TimeLimits": [
    {
      "DaylightSaving": 1,
      "EndDate": "2025-10-30T06:08:02.7740426+02:00",
      "LimitType": 2,
      "LNKey_ID": "738de8d5-8b15-4847-9dde-2966a7e8624f",
      "LNKeyTimeLimit_ID": "60801914-28e4-483d-985c-3517d2bca9b3",
      "OrderNo": 5,
      "RenewEndDate": "2025-10-30T06:08:02.7740426+02:00",
      "RenewGapCount": 7,
      "RenewGapType": 8,
      "RenewMinute": 9,
      "StartDate": "2025-10-30T06:08:02.7740426+02:00",
      "WeekDay": 10
    },
    {
      "DaylightSaving": 1,
      "EndDate": "2025-10-30T06:08:02.7740426+02:00",
      "LimitType": 2,
      "LNKey_ID": "738de8d5-8b15-4847-9dde-2966a7e8624f",
      "LNKeyTimeLimit_ID": "60801914-28e4-483d-985c-3517d2bca9b3",
      "OrderNo": 5,
      "RenewEndDate": "2025-10-30T06:08:02.7740426+02:00",
      "RenewGapCount": 7,
      "RenewGapType": 8,
      "RenewMinute": 9,
      "StartDate": "2025-10-30T06:08:02.7740426+02:00",
      "WeekDay": 10
    }
  ],
  "ZoneIds": [
    "0d75cd67-65d3-40e9-8abb-de706e705c77",
    "24a8d842-cf34-4226-8c12-7516a993b02d"
  ]
}

application/xml, text/xml

Sample: 
<KeyParams.InsertKeyParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.ws.WebApi.Params">
  <Key xmlns:d2p1="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
    <d2p1:Description>sample string 1</d2p1:Description>
    <d2p1:ExpireDate>2025-10-30T06:08:02.7740426+02:00</d2p1:ExpireDate>
    <d2p1:FNKey_ID>02e0507e-55e9-4b22-a2b4-47ca92dcaf6d</d2p1:FNKey_ID>
    <d2p1:InfoText>sample string 2</d2p1:InfoText>
    <d2p1:ManufacturingInfo>sample string 3</d2p1:ManufacturingInfo>
    <d2p1:OnlineAccessCode>sample string 4</d2p1:OnlineAccessCode>
    <d2p1:Person_ID>24ce5661-5775-4056-aa11-a7016309c99b</d2p1:Person_ID>
    <d2p1:ROM_ID>sample string 6</d2p1:ROM_ID>
    <d2p1:RealEstate_ID>b7fc2e36-e236-43ef-98a3-e852c51ba05c</d2p1:RealEstate_ID>
    <d2p1:Stamp>sample string 7</d2p1:Stamp>
    <d2p1:TagKey>sample string 8</d2p1:TagKey>
    <d2p1:VersionCode>sample string 9</d2p1:VersionCode>
  </Key>
  <SecurityAccessIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>7a292f4a-2a29-4287-a375-896e71613df8</d2p1:guid>
    <d2p1:guid>c8450a33-da7a-42bc-940e-976f5022b790</d2p1:guid>
  </SecurityAccessIds>
  <TimeLimits xmlns:d2p1="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
    <d2p1:KeyTimeLimit>
      <d2p1:DaylightSaving>1</d2p1:DaylightSaving>
      <d2p1:EndDate>2025-10-30T06:08:02.7740426+02:00</d2p1:EndDate>
      <d2p1:LNKeyTimeLimit_ID>60801914-28e4-483d-985c-3517d2bca9b3</d2p1:LNKeyTimeLimit_ID>
      <d2p1:LNKey_ID>738de8d5-8b15-4847-9dde-2966a7e8624f</d2p1:LNKey_ID>
      <d2p1:LimitType>2</d2p1:LimitType>
      <d2p1:OrderNo>5</d2p1:OrderNo>
      <d2p1:RenewEndDate>2025-10-30T06:08:02.7740426+02:00</d2p1:RenewEndDate>
      <d2p1:RenewGapCount>7</d2p1:RenewGapCount>
      <d2p1:RenewGapType>8</d2p1:RenewGapType>
      <d2p1:RenewMinute>9</d2p1:RenewMinute>
      <d2p1:StartDate>2025-10-30T06:08:02.7740426+02:00</d2p1:StartDate>
      <d2p1:WeekDay>10</d2p1:WeekDay>
    </d2p1:KeyTimeLimit>
    <d2p1:KeyTimeLimit>
      <d2p1:DaylightSaving>1</d2p1:DaylightSaving>
      <d2p1:EndDate>2025-10-30T06:08:02.7740426+02:00</d2p1:EndDate>
      <d2p1:LNKeyTimeLimit_ID>60801914-28e4-483d-985c-3517d2bca9b3</d2p1:LNKeyTimeLimit_ID>
      <d2p1:LNKey_ID>738de8d5-8b15-4847-9dde-2966a7e8624f</d2p1:LNKey_ID>
      <d2p1:LimitType>2</d2p1:LimitType>
      <d2p1:OrderNo>5</d2p1:OrderNo>
      <d2p1:RenewEndDate>2025-10-30T06:08:02.7740426+02:00</d2p1:RenewEndDate>
      <d2p1:RenewGapCount>7</d2p1:RenewGapCount>
      <d2p1:RenewGapType>8</d2p1:RenewGapType>
      <d2p1:RenewMinute>9</d2p1:RenewMinute>
      <d2p1:StartDate>2025-10-30T06:08:02.7740426+02:00</d2p1:StartDate>
      <d2p1:WeekDay>10</d2p1:WeekDay>
    </d2p1:KeyTimeLimit>
  </TimeLimits>
  <ZoneIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>0d75cd67-65d3-40e9-8abb-de706e705c77</d2p1:guid>
    <d2p1:guid>24a8d842-cf34-4226-8c12-7516a993b02d</d2p1:guid>
  </ZoneIds>
</KeyParams.InsertKeyParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Key
NameDescriptionTypeAdditional information
FNKey_ID

Key Id

 globally unique identifier

None.
ROM_ID

ROM ID

 string

None.
Description

Description text

 string

None.
ExpireDate

Expiration date. Null if the key doesn't expire.

 date (nullable)

None.
InfoText

Additional info text

 string

None.
Person_ID

Person to whom the key is linked to. Null if the key isn't linked to anyone.

 globally unique identifier (nullable)

None.
RealEstate_ID

ID of the real estate where this key belongs to.

 globally unique identifier

None.
Stamp

Stamp. Number consisting of 4 digits written to the physical key.

 string

Required

String length: inclusive between 0 and 10
State

Current state

 pniFNKeyState

None.
TagKey

TFID Tag. Empty string if not given.

 string

None.
StampSource

The source of the key labeling (Stamp). Read only.

 KeyStampSource

None.
TagKeySource

The source of the key's tagkey enumeration. Read only.

 TagKeySource

None.
VersionCode

Version information.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "FNKey_ID": "c642e23a-5b74-4025-b188-cf73fb044092",
  "ROM_ID": "sample string 2",
  "Description": "sample string 3",
  "ExpireDate": "2025-10-30T06:08:02.7896682+02:00",
  "InfoText": "sample string 4",
  "Person_ID": "4e3165d0-de27-4494-b757-2acbabc21bc4",
  "RealEstate_ID": "3faa6915-d078-4120-86d1-050a751f74ed",
  "Stamp": "sample string 6",
  "State": 7,
  "TagKey": "sample string 8",
  "StampSource": 9,
  "TagKeySource": 10,
  "VersionCode": "sample string 11"
}

application/xml, text/xml

Sample: 
<Key xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
  <Description>sample string 3</Description>
  <ExpireDate>2025-10-30T06:08:02.7896682+02:00</ExpireDate>
  <FNKey_ID>c642e23a-5b74-4025-b188-cf73fb044092</FNKey_ID>
  <InfoText>sample string 4</InfoText>
  <Person_ID>4e3165d0-de27-4494-b757-2acbabc21bc4</Person_ID>
  <ROM_ID>sample string 2</ROM_ID>
  <RealEstate_ID>3faa6915-d078-4120-86d1-050a751f74ed</RealEstate_ID>
  <Stamp>sample string 6</Stamp>
  <StampSource>9</StampSource>
  <State>7</State>
  <TagKey>sample string 8</TagKey>
  <TagKeySource>10</TagKeySource>
  <VersionCode>sample string 11</VersionCode>
</Key>