GET api/v1/Keys/{id}/SecurityAccesses?mode={mode}
Gets key's security accesses
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Key id |
globally unique identifier |
Required |
| mode |
Mode |
GetSecurityAccessesView |
Required |
Body Parameters
None.
Response Information
Resource Description
GetKeySecurityAccessesResult| Name | Description | Type | Additional information |
|---|---|---|---|
| SecurityAccesses |
Security accesses linked to keys which are visible to user |
Collection of SecurityAccess |
None. |
| OutsideUserZonesCount |
How many of additional security accesses are linked to the key which are invisible to user because they are outside his zones |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"SecurityAccesses": [
{
"AccessMode": 1,
"DefaultAccess": 2,
"Description": "sample string 3",
"Ext": 4,
"ExtDescription": "sample string 5",
"Name": "sample string 6",
"ParentSecurityAccess_ID": "0c8c273d-e6ae-4ddb-ac36-6936d09c4e1a",
"RealEstate_ID": "3abc5efd-a87c-40b4-8fbc-92da7952b530",
"SecurityAccess_ID": "f754f0a1-7313-42b9-b28e-9d0e054cd5b6",
"Zone_ID": "c276c86b-210c-40ee-95be-21860c23a5e8",
"Status": 9,
"Type": 10,
"Value": 11,
"VersionNr": 1
},
{
"AccessMode": 1,
"DefaultAccess": 2,
"Description": "sample string 3",
"Ext": 4,
"ExtDescription": "sample string 5",
"Name": "sample string 6",
"ParentSecurityAccess_ID": "0c8c273d-e6ae-4ddb-ac36-6936d09c4e1a",
"RealEstate_ID": "3abc5efd-a87c-40b4-8fbc-92da7952b530",
"SecurityAccess_ID": "f754f0a1-7313-42b9-b28e-9d0e054cd5b6",
"Zone_ID": "c276c86b-210c-40ee-95be-21860c23a5e8",
"Status": 9,
"Type": 10,
"Value": 11,
"VersionNr": 1
}
],
"OutsideUserZonesCount": 1
}
application/xml, text/xml
Sample:
<KeyParams.GetKeySecurityAccessesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.ws.WebApi.Params">
<OutsideUserZonesCount>1</OutsideUserZonesCount>
<SecurityAccesses xmlns:d2p1="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
<d2p1:SecurityAccess>
<d2p1:AccessMode>1</d2p1:AccessMode>
<d2p1:DefaultAccess>2</d2p1:DefaultAccess>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:Ext>4</d2p1:Ext>
<d2p1:ExtDescription>sample string 5</d2p1:ExtDescription>
<d2p1:Name>sample string 6</d2p1:Name>
<d2p1:ParentSecurityAccess_ID>0c8c273d-e6ae-4ddb-ac36-6936d09c4e1a</d2p1:ParentSecurityAccess_ID>
<d2p1:RealEstate_ID>3abc5efd-a87c-40b4-8fbc-92da7952b530</d2p1:RealEstate_ID>
<d2p1:SecurityAccess_ID>f754f0a1-7313-42b9-b28e-9d0e054cd5b6</d2p1:SecurityAccess_ID>
<d2p1:Status>9</d2p1:Status>
<d2p1:Type>10</d2p1:Type>
<d2p1:Value>11</d2p1:Value>
<d2p1:VersionNr>1</d2p1:VersionNr>
<d2p1:Zone_ID>c276c86b-210c-40ee-95be-21860c23a5e8</d2p1:Zone_ID>
</d2p1:SecurityAccess>
<d2p1:SecurityAccess>
<d2p1:AccessMode>1</d2p1:AccessMode>
<d2p1:DefaultAccess>2</d2p1:DefaultAccess>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:Ext>4</d2p1:Ext>
<d2p1:ExtDescription>sample string 5</d2p1:ExtDescription>
<d2p1:Name>sample string 6</d2p1:Name>
<d2p1:ParentSecurityAccess_ID>0c8c273d-e6ae-4ddb-ac36-6936d09c4e1a</d2p1:ParentSecurityAccess_ID>
<d2p1:RealEstate_ID>3abc5efd-a87c-40b4-8fbc-92da7952b530</d2p1:RealEstate_ID>
<d2p1:SecurityAccess_ID>f754f0a1-7313-42b9-b28e-9d0e054cd5b6</d2p1:SecurityAccess_ID>
<d2p1:Status>9</d2p1:Status>
<d2p1:Type>10</d2p1:Type>
<d2p1:Value>11</d2p1:Value>
<d2p1:VersionNr>1</d2p1:VersionNr>
<d2p1:Zone_ID>c276c86b-210c-40ee-95be-21860c23a5e8</d2p1:Zone_ID>
</d2p1:SecurityAccess>
</SecurityAccesses>
</KeyParams.GetKeySecurityAccessesResult>