GET api/SAIUserPreference/GetUserPreferenceByControl/{key}

Request Information

URI Parameters

Name	Description	Type	Additional information
key		string	Required

Body Parameters

None.

Response Information

Resource Description

SAIUserPreference

Name	Type	Additional information
AccountId	integer	None.
CompanyId	string	None.
UserId	integer	None.
UserName	string	None.
key	string	None.
value	string	None.
BreakType1	integer	None.
BreakCode1	string	None.
BreakType2	integer	None.
BreakCode2	string	None.
CreatedOn	date	None.
CreatedBy	string	None.
UpdatedOn	date	None.
UpdatedBy	string	None.
IsLockedForEditing	boolean	None.
LockedBy	string	None.
Id	integer	None.
FieldPermissions	Collection of DTOFieldPermission	None.

Response Formats

application/json, text/json

Sample:

{
  "AccountId": 1,
  "CompanyId": "sample string 2",
  "UserId": 3,
  "UserName": "sample string 4",
  "key": "sample string 5",
  "value": "sample string 6",
  "BreakType1": 1,
  "BreakCode1": "sample string 7",
  "BreakType2": 1,
  "BreakCode2": "sample string 8",
  "CreatedOn": "2025-12-16T14:40:01.6447114+00:00",
  "CreatedBy": "sample string 10",
  "UpdatedOn": "2025-12-16T14:40:01.6447114+00:00",
  "UpdatedBy": "sample string 11",
  "IsLockedForEditing": true,
  "LockedBy": "sample string 13",
  "Id": 14,
  "FieldPermissions": []
}

application/xml, text/xml

Sample:

<SAIUserPreference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.SAI">
  <Id xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">14</Id>
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 10</CreatedBy>
  <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T14:40:01.6447114+00:00</CreatedOn>
  <IsLockedForEditing xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">true</IsLockedForEditing>
  <LockedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 13</LockedBy>
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 11</UpdatedBy>
  <UpdatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T14:40:01.6447114+00:00</UpdatedOn>
  <AccountId>1</AccountId>
  <BreakCode1>sample string 7</BreakCode1>
  <BreakCode2>sample string 8</BreakCode2>
  <BreakType1>1</BreakType1>
  <BreakType2>1</BreakType2>
  <CompanyId>sample string 2</CompanyId>
  <UserId>3</UserId>
  <UserName>sample string 4</UserName>
  <key>sample string 5</key>
  <value>sample string 6</value>
</SAIUserPreference>