GET api/v1/SecurityRoles/{id}
Returns security role data by its ID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
SecurityRoleName | Description | Type | Additional information |
---|---|---|---|
Description |
Description |
string |
None. |
Name |
Name |
string |
None. |
OnlineAccessCode |
Online access code. Empty when retrieving security roles and must be retrieved with a different method. If given as empty string during update, uses previous code. |
string |
None. |
OnlineRelayOperatingTimeMs |
How long the relay is on after access is granted. In milliseconds. |
integer |
None. |
RealEstate_ID |
Real estate id |
globally unique identifier |
None. |
SecurityRole_ID |
ID |
globally unique identifier |
None. |
TypeMask |
Type |
SecurityRoleTypeMask |
None. |
Zone_ID |
Zone id |
globally unique identifier (nullable) |
None. |
Response Formats
application/json, text/json
Sample:
{ "Description": "sample string 1", "Name": "sample string 2", "OnlineAccessCode": "sample string 3", "OnlineRelayOperatingTimeMs": 4, "RealEstate_ID": "f9fe2dee-05a9-448f-9945-1060e5585be7", "SecurityRole_ID": "5aa0f4d2-9ac8-4f65-9e9a-3fd999adae8a", "TypeMask": 0, "Zone_ID": "7aa5ba36-286e-40e8-acf6-2c80fabbfb14" }
application/xml, text/xml
Sample:
<SecurityRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus"> <Description>sample string 1</Description> <Name>sample string 2</Name> <OnlineAccessCode>sample string 3</OnlineAccessCode> <OnlineRelayOperatingTimeMs>4</OnlineRelayOperatingTimeMs> <RealEstate_ID>f9fe2dee-05a9-448f-9945-1060e5585be7</RealEstate_ID> <SecurityRole_ID>5aa0f4d2-9ac8-4f65-9e9a-3fd999adae8a</SecurityRole_ID> <TypeMask>None</TypeMask> <Zone_ID>7aa5ba36-286e-40e8-acf6-2c80fabbfb14</Zone_ID> </SecurityRole>