GET api/v1/Keys/GetByRomIds?romIds[0]={romIds[0]}&romIds[1]={romIds[1]}
Gets key informations by keys' rom ids
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| romIds |
Rom ids |
Collection of string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of 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": "48aabc2a-8112-47a7-98ff-ac1df7115d8c",
"ROM_ID": "sample string 2",
"Description": "sample string 3",
"ExpireDate": "2026-03-17T02:47:17.2968017+02:00",
"InfoText": "sample string 4",
"Person_ID": "61a37d35-a40e-42ca-8527-b28aa7802a62",
"RealEstate_ID": "579006f2-4771-4b01-84b2-7d47ea32fe9f",
"Stamp": "sample string 6",
"State": 7,
"TagKey": "sample string 8",
"StampSource": 9,
"TagKeySource": 10,
"VersionCode": "sample string 11"
},
{
"FNKey_ID": "48aabc2a-8112-47a7-98ff-ac1df7115d8c",
"ROM_ID": "sample string 2",
"Description": "sample string 3",
"ExpireDate": "2026-03-17T02:47:17.2968017+02:00",
"InfoText": "sample string 4",
"Person_ID": "61a37d35-a40e-42ca-8527-b28aa7802a62",
"RealEstate_ID": "579006f2-4771-4b01-84b2-7d47ea32fe9f",
"Stamp": "sample string 6",
"State": 7,
"TagKey": "sample string 8",
"StampSource": 9,
"TagKeySource": 10,
"VersionCode": "sample string 11"
}
]
application/xml, text/xml
Sample:
<ArrayOfKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
<Key>
<Description>sample string 3</Description>
<ExpireDate>2026-03-17T02:47:17.2968017+02:00</ExpireDate>
<FNKey_ID>48aabc2a-8112-47a7-98ff-ac1df7115d8c</FNKey_ID>
<InfoText>sample string 4</InfoText>
<Person_ID>61a37d35-a40e-42ca-8527-b28aa7802a62</Person_ID>
<ROM_ID>sample string 2</ROM_ID>
<RealEstate_ID>579006f2-4771-4b01-84b2-7d47ea32fe9f</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>
<Key>
<Description>sample string 3</Description>
<ExpireDate>2026-03-17T02:47:17.2968017+02:00</ExpireDate>
<FNKey_ID>48aabc2a-8112-47a7-98ff-ac1df7115d8c</FNKey_ID>
<InfoText>sample string 4</InfoText>
<Person_ID>61a37d35-a40e-42ca-8527-b28aa7802a62</Person_ID>
<ROM_ID>sample string 2</ROM_ID>
<RealEstate_ID>579006f2-4771-4b01-84b2-7d47ea32fe9f</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>
</ArrayOfKey>