GET Preference/GetWebDbSettings?key={key}&whatSetting={whatSetting}

Returns the Web Database preferences for the setting that is passed in.

Request Information

URI Parameters

Name	Description	Type	Additional Information
key	The secrete key to allow access to the web database preferences.	string	Required
whatSetting	What setting to retrieve from the web database.	string	Required

Body Parameters

Response Information

Resource Description

Returns the Web Database preferences for the setting that is passed in.

AgvPreference

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many Preferences.	string
PreferenceRecords	JSON dictionary of PreferenceRecords.	Collection of clsAPIPreference

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "PreferenceRecords": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvPreference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Preference">
  <Count>sample string 3</Count>
  <Message>sample string 2</Message>
  <PreferenceRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.API">
    <d2p1:clsAPIPreference>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:clsAPIPreference>
    <d2p1:clsAPIPreference>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:clsAPIPreference>
  </PreferenceRecords>
  <Status>sample string 1</Status>
</AgvPreference>