POST api/v1/SetLockgroup

Sets user's session's lockgroup information. Call after CreateSession and GetLockGroups is called.

Request Information

URI Parameters

None.

Body Parameters

SetLockgroupParam
NameDescriptionTypeAdditional information
LockGroup_ID

LockGroup's ID user is logging in to.

 globally unique identifier

None.
AdapterVersion

enuAdapterVersion

None.
MasterRomID

Master token's Rom ID if token is attached to an adapter. Null if not available.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "LockGroup_ID": "c1b06d40-1093-4551-a7b4-1e02e8878824",
  "AdapterVersion": 2,
  "MasterRomID": "sample string 3"
}

application/xml, text/xml

Sample: 
<IloParams.SetLockgroupParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.ws.WebApi.Params">
  <AdapterVersion>2</AdapterVersion>
  <LockGroup_ID>c1b06d40-1093-4551-a7b4-1e02e8878824</LockGroup_ID>
  <MasterRomID>sample string 3</MasterRomID>
</IloParams.SetLockgroupParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SetLockgroupResult
NameDescriptionTypeAdditional information
RightsMask

User's rights as a bit mask.

 prnUserRightsEnum

None.

Response Formats

application/json, text/json

Sample: 
{
  "RightsMask": 1
}

application/xml, text/xml

Sample: 
<IloParams.SetLockgroupResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.ws.WebApi.Params">
  <RightsMask>1</RightsMask>
</IloParams.SetLockgroupResult>