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": "92b35b7f-2227-4aa0-a8fe-68131417b218", "SecurityRole_ID": "b5ece141-8b33-4457-ae10-c02b488fe608", "TypeMask": 0, "Zone_ID": "3868b5f0-5d4c-414f-978e-4725a0cd6374" }
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>92b35b7f-2227-4aa0-a8fe-68131417b218</RealEstate_ID> <SecurityRole_ID>b5ece141-8b33-4457-ae10-c02b488fe608</SecurityRole_ID> <TypeMask>None</TypeMask> <Zone_ID>3868b5f0-5d4c-414f-978e-4725a0cd6374</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": "a38a5206-f199-4e63-a994-5c96891cd9cc", "SecurityRole_ID": "b2993956-940e-40f8-b160-58e97f7b1287", "TypeMask": 0, "Zone_ID": "cde3cf0d-c28e-49af-8d1a-2c86d0ce3f13" }
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>a38a5206-f199-4e63-a994-5c96891cd9cc</RealEstate_ID> <SecurityRole_ID>b2993956-940e-40f8-b160-58e97f7b1287</SecurityRole_ID> <TypeMask>None</TypeMask> <Zone_ID>cde3cf0d-c28e-49af-8d1a-2c86d0ce3f13</Zone_ID> </SecurityRole>