POST v1/Employees/{id}/UserPreferences

update the employees user preferences

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Id of the employee	string	Required

Body Parameters

Preferences to be updated

UserPreferenceDTO

Name	Type	Additional information
UserPreferencesID	integer	None.
EmployeeID	integer	None.
LocalizationLanguage	string	None.
DataEntryViewMode	string	None.
DashboardIsSet	boolean	None.
DashboardSettingsAreSet	boolean	None.
FileViewType	string	None.
TimezoneValue	string	None.
PopupImportantNotes	boolean	None.
SearchPreference	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserPreferencesID": 1,
  "EmployeeID": 2,
  "LocalizationLanguage": "sample string 3",
  "DataEntryViewMode": "sample string 4",
  "DashboardIsSet": true,
  "DashboardSettingsAreSet": true,
  "FileViewType": "sample string 7",
  "TimezoneValue": "sample string 8",
  "PopupImportantNotes": true,
  "SearchPreference": "sample string 10"
}

application/xml, text/xml

Sample:

<UserPreferenceDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <DashboardIsSet>true</DashboardIsSet>
  <DashboardSettingsAreSet>true</DashboardSettingsAreSet>
  <DataEntryViewMode>sample string 4</DataEntryViewMode>
  <EmployeeID>2</EmployeeID>
  <FileViewType>sample string 7</FileViewType>
  <LocalizationLanguage>sample string 3</LocalizationLanguage>
  <PopupImportantNotes>true</PopupImportantNotes>
  <SearchPreference>sample string 10</SearchPreference>
  <TimezoneValue>sample string 8</TimezoneValue>
  <UserPreferencesID>1</UserPreferencesID>
</UserPreferenceDTO>

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 'UserPreferenceDTO'.

Response Information

Resource Description

Updated employees user preferences

ActionResultDTOOfUserPreferenceDTO

Name	Type	Additional information
Result	UserPreferenceDTO	None.
CreatedBy	string	None.
EntityID	integer	None.
RowSource	string	None.
PolicyID	integer	None.
IsSuccess	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
InfoMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "UserPreferencesID": 1,
    "EmployeeID": 2,
    "LocalizationLanguage": "sample string 3",
    "DataEntryViewMode": "sample string 4",
    "DashboardIsSet": true,
    "DashboardSettingsAreSet": true,
    "FileViewType": "sample string 7",
    "TimezoneValue": "sample string 8",
    "PopupImportantNotes": true,
    "SearchPreference": "sample string 10"
  },
  "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:

<ActionResultOfUserPreferenceDTO 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.Contacts">
    <d2p1:DashboardIsSet>true</d2p1:DashboardIsSet>
    <d2p1:DashboardSettingsAreSet>true</d2p1:DashboardSettingsAreSet>
    <d2p1:DataEntryViewMode>sample string 4</d2p1:DataEntryViewMode>
    <d2p1:EmployeeID>2</d2p1:EmployeeID>
    <d2p1:FileViewType>sample string 7</d2p1:FileViewType>
    <d2p1:LocalizationLanguage>sample string 3</d2p1:LocalizationLanguage>
    <d2p1:PopupImportantNotes>true</d2p1:PopupImportantNotes>
    <d2p1:SearchPreference>sample string 10</d2p1:SearchPreference>
    <d2p1:TimezoneValue>sample string 8</d2p1:TimezoneValue>
    <d2p1:UserPreferencesID>1</d2p1:UserPreferencesID>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfUserPreferenceDTO>