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

SecurityRole

Name	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": "aa9fc2e7-4243-4ca8-b221-58840dcda204",
  "SecurityRole_ID": "4f17937d-9c9a-4bd5-9345-162027b27246",
  "TypeMask": 0,
  "Zone_ID": "6f58bb6d-9405-4616-8b6d-fca35a2e3b8f"
}

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>aa9fc2e7-4243-4ca8-b221-58840dcda204</RealEstate_ID>
  <SecurityRole_ID>4f17937d-9c9a-4bd5-9345-162027b27246</SecurityRole_ID>
  <TypeMask>None</TypeMask>
  <Zone_ID>6f58bb6d-9405-4616-8b6d-fca35a2e3b8f</Zone_ID>
</SecurityRole>