GET api/AdminSettings/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

BGMAdminSettingsBindingModel
NameDescriptionTypeAdditional information
IDConfig

string

None.
Description

string

String length: inclusive between 0 and 100
lockOutAllUsers

boolean

None.
matchChangeRetroactivePeriod

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "IDConfig": "sample string 1",
  "Description": "sample string 2",
  "lockOutAllUsers": true,
  "matchChangeRetroactivePeriod": 4
}

application/xml, text/xml

Sample: 
<BGMAdminSettingsBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BGManagerApi">
  <Description>sample string 2</Description>
  <IDConfig>sample string 1</IDConfig>
  <lockOutAllUsers>true</lockOutAllUsers>
  <matchChangeRetroactivePeriod>4</matchChangeRetroactivePeriod>
</BGMAdminSettingsBindingModel>