GET v1/Menus/SiteExclusions/{designId}
Retrieve site exclusions by designId
URI template
v1/Menus/SiteExclusions/{designId}?offset={offset}&limit={limit}&siteId={siteId}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
designId | integer |
Required |
|
offset | integer |
Default value is 0 |
|
limit | integer |
Default value is 20000 |
|
siteId | integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
SiteExclusionsResults
Name | Description | Type | Additional information |
---|---|---|---|
CurrentOffset |
Current offset
|
integer |
None. |
TotalCount |
Total count of site exclusions data
|
integer |
None. |
SiteMenus |
Gets or sets site menu property
|
Collection of SiteMenu |
None. |
MenuItemMemberships |
Gets or sets menu item property
|
MenuItemMemberships |
None. |
SubMenuMemberships |
Gets or sets sub menu item property
|
SubMenuMemberships |
None. |
SalesItemMemberships |
Gets or sets sales item membership property
|
SalesItemMemberships |
None. |
SalesItemOptionMemberships |
Gets or sets sales item options property
|
SalesItemOptionMemberships |
None. |
QuickComboMemberships |
Gets or sets quick combo property
|
QuickComboMemberships |
None. |
Response Formats
application/json, text/json
Sample:
{ "CurrentOffset": 1, "TotalCount": 2, "SiteMenus": [ { "$id": "2", "SiteId": 3, "MenuId": 4 }, { "$id": "3", "SiteId": 5, "MenuId": 6 } ], "MenuItemMemberships": { "$id": "4", "Columns": [ "sample string 7", "sample string 8" ], "Data": [ [ { "$id": "5" }, { "$id": "6" } ], [ { "$id": "7" }, { "$id": "8" } ] ] }, "SubMenuMemberships": { "$id": "9", "Columns": [ "sample string 13", "sample string 14" ], "Data": [ [ { "$id": "10" }, { "$id": "11" } ], [ { "$id": "12" }, { "$id": "13" } ] ] }, "SalesItemMemberships": { "$id": "14", "Columns": [ "sample string 19", "sample string 20" ], "Data": [ [ { "$id": "15" }, { "$id": "16" } ], [ { "$id": "17" }, { "$id": "18" } ] ] }, "SalesItemOptionMemberships": { "$id": "19", "Columns": [ "sample string 25", "sample string 26" ], "Data": [ [ { "$id": "20" }, { "$id": "21" } ], [ { "$id": "22" }, { "$id": "23" } ] ] }, "QuickComboMemberships": { "$id": "24", "Columns": [ "sample string 31", "sample string 32" ], "Data": [ [ { "$id": "25" }, { "$id": "26" } ], [ { "$id": "27" }, { "$id": "28" } ] ] } }
application/xml, text/xml
Sample:
<SiteExclusionsResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response"> <CurrentOffset>1</CurrentOffset> <MenuItemMemberships> <Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 7</d3p1:string> <d3p1:string>sample string 8</d3p1:string> </Columns> <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> </Data> </MenuItemMemberships> <QuickComboMemberships> <Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 31</d3p1:string> <d3p1:string>sample string 32</d3p1:string> </Columns> <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> </Data> </QuickComboMemberships> <SalesItemMemberships> <Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 19</d3p1:string> <d3p1:string>sample string 20</d3p1:string> </Columns> <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> </Data> </SalesItemMemberships> <SalesItemOptionMemberships> <Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 25</d3p1:string> <d3p1:string>sample string 26</d3p1:string> </Columns> <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> </Data> </SalesItemOptionMemberships> <SiteMenus> <SiteMenu> <MenuId>4</MenuId> <SiteId>3</SiteId> </SiteMenu> <SiteMenu> <MenuId>6</MenuId> <SiteId>5</SiteId> </SiteMenu> </SiteMenus> <SubMenuMemberships> <Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 13</d3p1:string> <d3p1:string>sample string 14</d3p1:string> </Columns> <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> <d3p1:ArrayOfanyType> <d3p1:anyType /> <d3p1:anyType /> </d3p1:ArrayOfanyType> </Data> </SubMenuMemberships> <TotalCount>2</TotalCount> </SiteExclusionsResults>