POST api/v1/SecurityRoles
Adds new security role
Request Information
URI Parameters
None.
Body Parameters
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. |
Request Formats
application/json, text/json
Sample:
{ "Description": "sample string 1", "Name": "sample string 2", "OnlineAccessCode": "sample string 3", "OnlineRelayOperatingTimeMs": 4, "RealEstate_ID": "d5ecfd14-d80e-4250-b20c-3edf7d7f81f5", "SecurityRole_ID": "0126e09b-7b98-4de6-96e6-e99b47ea5ebd", "TypeMask": 0, "Zone_ID": "c033634a-e70f-460e-8eec-98747c37d0ca" }
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>d5ecfd14-d80e-4250-b20c-3edf7d7f81f5</RealEstate_ID> <SecurityRole_ID>0126e09b-7b98-4de6-96e6-e99b47ea5ebd</SecurityRole_ID> <TypeMask>None</TypeMask> <Zone_ID>c033634a-e70f-460e-8eec-98747c37d0ca</Zone_ID> </SecurityRole>
application/x-www-form-urlencoded
Sample:
Sample not available.
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": "6fe8bf2d-af9e-46cc-bb83-bf575ffb3e53", "SecurityRole_ID": "a8dc4776-8349-412d-b09e-5c4bafafbd02", "TypeMask": 0, "Zone_ID": "31535f24-7dfb-45b7-8700-c4d49853048a" }
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>6fe8bf2d-af9e-46cc-bb83-bf575ffb3e53</RealEstate_ID> <SecurityRole_ID>a8dc4776-8349-412d-b09e-5c4bafafbd02</SecurityRole_ID> <TypeMask>None</TypeMask> <Zone_ID>31535f24-7dfb-45b7-8700-c4d49853048a</Zone_ID> </SecurityRole>