PUT api/v1/SecurityRoles
Updates existing security role
Request Information
URI Parameters
None.
Body Parameters
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. |
Request Formats
application/json, text/json
Sample:
{
"Description": "sample string 1",
"Name": "sample string 2",
"OnlineAccessCode": "sample string 3",
"OnlineRelayOperatingTimeMs": 4,
"RealEstate_ID": "21572443-8a1c-4baf-ba22-28a8e6ad5036",
"SecurityRole_ID": "b7cd3bcb-c8a6-4f49-bab2-29c2d0d62040",
"TypeMask": 0,
"Zone_ID": "deeaf56e-d3f4-4a41-9fd4-b0c95ae0bdd2"
}
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>21572443-8a1c-4baf-ba22-28a8e6ad5036</RealEstate_ID> <SecurityRole_ID>b7cd3bcb-c8a6-4f49-bab2-29c2d0d62040</SecurityRole_ID> <TypeMask>None</TypeMask> <Zone_ID>deeaf56e-d3f4-4a41-9fd4-b0c95ae0bdd2</Zone_ID> </SecurityRole>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.