POST api/v1/Keys

Adds new key

Request Information

URI Parameters

None.

Body Parameters

Parameter

Name	Description	Type	Additional 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": "a67e6f9a-ab22-4440-841d-0d2bc793060e",
    "Description": "sample string 1",
    "ExpireDate": "2026-03-17T02:43:20.5011712+02:00",
    "InfoText": "sample string 2",
    "ManufacturingInfo": "sample string 3",
    "OnlineAccessCode": "sample string 4",
    "Person_ID": "5f25d8e8-75a8-4dc5-a500-b9594d67da41",
    "RealEstate_ID": "f7144d54-dfcf-497d-9c9c-c737b525f93c",
    "ROM_ID": "sample string 6",
    "Stamp": "sample string 7",
    "TagKey": "sample string 8",
    "VersionCode": "sample string 9"
  },
  "SecurityAccessIds": [
    "cef5baf0-5708-4076-8937-afcb8a2b33a6",
    "af04050a-77ea-4dfe-b00c-5466eb5d34cb"
  ],
  "TimeLimits": [
    {
      "DaylightSaving": 1,
      "EndDate": "2026-03-17T02:43:20.5011712+02:00",
      "LimitType": 2,
      "LNKey_ID": "816ab881-dc89-49c0-b4c9-58b1451dbf7a",
      "LNKeyTimeLimit_ID": "97c2da8c-004b-4740-8dc9-ee96fbce2633",
      "OrderNo": 5,
      "RenewEndDate": "2026-03-17T02:43:20.5011712+02:00",
      "RenewGapCount": 7,
      "RenewGapType": 8,
      "RenewMinute": 9,
      "StartDate": "2026-03-17T02:43:20.5011712+02:00",
      "WeekDay": 10
    },
    {
      "DaylightSaving": 1,
      "EndDate": "2026-03-17T02:43:20.5011712+02:00",
      "LimitType": 2,
      "LNKey_ID": "816ab881-dc89-49c0-b4c9-58b1451dbf7a",
      "LNKeyTimeLimit_ID": "97c2da8c-004b-4740-8dc9-ee96fbce2633",
      "OrderNo": 5,
      "RenewEndDate": "2026-03-17T02:43:20.5011712+02:00",
      "RenewGapCount": 7,
      "RenewGapType": 8,
      "RenewMinute": 9,
      "StartDate": "2026-03-17T02:43:20.5011712+02:00",
      "WeekDay": 10
    }
  ],
  "ZoneIds": [
    "23e5451c-d54b-4e93-9bc0-6d9e0e170169",
    "26aa34c7-af35-4416-8c6a-6ee390898290"
  ]
}

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>2026-03-17T02:43:20.5011712+02:00</d2p1:ExpireDate>
    <d2p1:FNKey_ID>a67e6f9a-ab22-4440-841d-0d2bc793060e</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>5f25d8e8-75a8-4dc5-a500-b9594d67da41</d2p1:Person_ID>
    <d2p1:ROM_ID>sample string 6</d2p1:ROM_ID>
    <d2p1:RealEstate_ID>f7144d54-dfcf-497d-9c9c-c737b525f93c</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>cef5baf0-5708-4076-8937-afcb8a2b33a6</d2p1:guid>
    <d2p1:guid>af04050a-77ea-4dfe-b00c-5466eb5d34cb</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>2026-03-17T02:43:20.5011712+02:00</d2p1:EndDate>
      <d2p1:LNKeyTimeLimit_ID>97c2da8c-004b-4740-8dc9-ee96fbce2633</d2p1:LNKeyTimeLimit_ID>
      <d2p1:LNKey_ID>816ab881-dc89-49c0-b4c9-58b1451dbf7a</d2p1:LNKey_ID>
      <d2p1:LimitType>2</d2p1:LimitType>
      <d2p1:OrderNo>5</d2p1:OrderNo>
      <d2p1:RenewEndDate>2026-03-17T02:43:20.5011712+02:00</d2p1:RenewEndDate>
      <d2p1:RenewGapCount>7</d2p1:RenewGapCount>
      <d2p1:RenewGapType>8</d2p1:RenewGapType>
      <d2p1:RenewMinute>9</d2p1:RenewMinute>
      <d2p1:StartDate>2026-03-17T02:43:20.5011712+02:00</d2p1:StartDate>
      <d2p1:WeekDay>10</d2p1:WeekDay>
    </d2p1:KeyTimeLimit>
    <d2p1:KeyTimeLimit>
      <d2p1:DaylightSaving>1</d2p1:DaylightSaving>
      <d2p1:EndDate>2026-03-17T02:43:20.5011712+02:00</d2p1:EndDate>
      <d2p1:LNKeyTimeLimit_ID>97c2da8c-004b-4740-8dc9-ee96fbce2633</d2p1:LNKeyTimeLimit_ID>
      <d2p1:LNKey_ID>816ab881-dc89-49c0-b4c9-58b1451dbf7a</d2p1:LNKey_ID>
      <d2p1:LimitType>2</d2p1:LimitType>
      <d2p1:OrderNo>5</d2p1:OrderNo>
      <d2p1:RenewEndDate>2026-03-17T02:43:20.5011712+02:00</d2p1:RenewEndDate>
      <d2p1:RenewGapCount>7</d2p1:RenewGapCount>
      <d2p1:RenewGapType>8</d2p1:RenewGapType>
      <d2p1:RenewMinute>9</d2p1:RenewMinute>
      <d2p1:StartDate>2026-03-17T02:43:20.5011712+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>23e5451c-d54b-4e93-9bc0-6d9e0e170169</d2p1:guid>
    <d2p1:guid>26aa34c7-af35-4416-8c6a-6ee390898290</d2p1:guid>
  </ZoneIds>
</KeyParams.InsertKeyParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Key

Name	Description	Type	Additional 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": "9035ca03-c32c-4058-b8a0-d643f7eaa96d",
  "ROM_ID": "sample string 2",
  "Description": "sample string 3",
  "ExpireDate": "2026-03-17T02:43:20.5167977+02:00",
  "InfoText": "sample string 4",
  "Person_ID": "7d515389-de65-4d79-b8ae-2cef33be8bb9",
  "RealEstate_ID": "927e6015-d172-4b64-bb88-eebbfa7f07f3",
  "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>2026-03-17T02:43:20.5167977+02:00</ExpireDate>
  <FNKey_ID>9035ca03-c32c-4058-b8a0-d643f7eaa96d</FNKey_ID>
  <InfoText>sample string 4</InfoText>
  <Person_ID>7d515389-de65-4d79-b8ae-2cef33be8bb9</Person_ID>
  <ROM_ID>sample string 2</ROM_ID>
  <RealEstate_ID>927e6015-d172-4b64-bb88-eebbfa7f07f3</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>