GET api/userSettings?screenId={screenId}

Gets available settings for the user, without values. These include settings that are user-specific, as well as settings that are stored at the accounting office, company and global level.

Request Information

URI Parameters

Name	Description	Type	Additional information
screenId	ID of a screen to fetch the values from.	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExistingUserSettingDTO

Name	Description	Type	Additional information
Name	Name for the settings.	string	None.
ShareLevel	The level that the settings are shared for: 1=Personal, 2=company, 3=accounting office, 4=global. Appropriate privileges are mandatory.	SettingShareLevel	None.
Value	Stored value for the setting.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "ShareLevel": 1,
    "Value": "sample string 2"
  },
  {
    "Name": "sample string 1",
    "ShareLevel": 1,
    "Value": "sample string 2"
  }
]

text/html

Sample:

[{"Name":"sample string 1","ShareLevel":1,"Value":"sample string 2"},{"Name":"sample string 1","ShareLevel":1,"Value":"sample string 2"}]

application/xml, text/xml

Sample:

<ArrayOfExistingUserSettingDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <ExistingUserSettingDTO>
    <Name>sample string 1</Name>
    <ShareLevel>Personal</ShareLevel>
    <Value>sample string 2</Value>
  </ExistingUserSettingDTO>
  <ExistingUserSettingDTO>
    <Name>sample string 1</Name>
    <ShareLevel>Personal</ShareLevel>
    <Value>sample string 2</Value>
  </ExistingUserSettingDTO>
</ArrayOfExistingUserSettingDTO>