POST v1/Locations/{locationID}/UserSettings

Update the User settings

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationID

Id of the location

string

Required

Body Parameters

User settings

SystemPreferenceDTO
NameDescriptionTypeAdditional information
SystemPreferencesID

Id of the system preference

integer

None.

TimeoutID

Timeout id

integer

None.

Timeout

Timeout

string

None.

LanguageID

Language id

string

None.

Language

Language

string

None.

LocationID

Id of the location

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SystemPreferencesID": 1,
  "TimeoutID": 2,
  "Timeout": "sample string 3",
  "LanguageID": "sample string 4",
  "Language": "sample string 5",
  "LocationID": 6
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SystemPreferenceDTO'.

application/xml, text/xml

Sample:
<SystemPreferenceDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Locations">
  <Language>sample string 5</Language>
  <LanguageID>sample string 4</LanguageID>
  <LocationID>6</LocationID>
  <SystemPreferencesID>1</SystemPreferencesID>
  <Timeout>sample string 3</Timeout>
  <TimeoutID>2</TimeoutID>
</SystemPreferenceDTO>

Response Information

Resource Description

Updated user settings

ActionResultDTOOfSystemPreferenceDTO
NameDescriptionTypeAdditional information
Result

SystemPreferenceDTO

None.

CreatedBy

string

None.

EntityID

integer

None.

RowSource

string

None.

PolicyID

integer

None.

IsSuccess

Signifies whether action is successful

boolean

None.

ErrorCode

Error code

string

None.

ErrorMessage

Error message

string

None.

InfoMessage

Information message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "SystemPreferencesID": 1,
    "TimeoutID": 2,
    "Timeout": "sample string 3",
    "LanguageID": "sample string 4",
    "Language": "sample string 5",
    "LocationID": 6
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:
<ActionResultOfSystemPreferenceDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Locations">
    <d2p1:Language>sample string 5</d2p1:Language>
    <d2p1:LanguageID>sample string 4</d2p1:LanguageID>
    <d2p1:LocationID>6</d2p1:LocationID>
    <d2p1:SystemPreferencesID>1</d2p1:SystemPreferencesID>
    <d2p1:Timeout>sample string 3</d2p1:Timeout>
    <d2p1:TimeoutID>2</d2p1:TimeoutID>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfSystemPreferenceDTO>