GET v1/Settings/{siteId}
Retrieves site settings
URI template
v1/Settings/{siteId}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteId |
Optional: The id of the site to retrieve site settings |
integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
A List of settings. Known internal errors are BadRequest and InvalidParameters
Collection of SettingName | Description | Type | Additional information |
---|---|---|---|
Name |
The name of the item |
string |
None. |
Value |
The value of the item |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "$id": "1", "Name": "sample string 1", "Value": "sample string 2" }, { "$id": "2", "Name": "sample string 3", "Value": "sample string 4" } ]
application/xml, text/xml
Sample:
<ArrayOfSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <Setting> <Name>sample string 1</Name> <Value>sample string 2</Value> </Setting> <Setting> <Name>sample string 3</Name> <Value>sample string 4</Value> </Setting> </ArrayOfSetting>