PUT api/v1/SecurityRoles
Updates existing 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": "c12e0d38-219b-4bd2-b32f-facd25179a89", "SecurityRole_ID": "5df842ce-b9fc-4cee-867e-0e62623e74f0", "TypeMask": 0, "Zone_ID": "e1b156fe-209e-4f60-9ae8-c34287fb6aff" }
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>c12e0d38-219b-4bd2-b32f-facd25179a89</RealEstate_ID> <SecurityRole_ID>5df842ce-b9fc-4cee-867e-0e62623e74f0</SecurityRole_ID> <TypeMask>None</TypeMask> <Zone_ID>e1b156fe-209e-4f60-9ae8-c34287fb6aff</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.