GET v1/Menus/SiteOverrides/{designId}
Gets overrides and memberships for all sites. Result is paged.
URI template
v1/Menus/SiteOverrides/{designId}?offset={offset}&limit={limit}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
designId |
designId |
integer |
Required |
offset | integer |
Default value is 0 |
|
limit | integer |
Default value is 20000 |
Body Parameters
None.
Response Information
Resource Description
A list of site overrides. Known internal errors are NotFound, BadRequest, InternalServerError
SiteOverridesResultName | Description | Type | Additional information |
---|---|---|---|
CurrentOffset | integer |
None. |
|
TotalCount | integer |
None. |
|
SiteMenus | Collection of SiteMenu |
None. |
|
PriceOverrides | PriceOverrides |
None. |
|
SalesItemOptionPriceOverrides | SalesItemOptionPriceOverrides |
None. |
|
MenuMemberships | MenuMemberships |
None. |
|
SubMenuMemberships | SubMenuMemberships |
None. |
|
MenuItemMemberships | MenuItemMemberships |
None. |
|
SalesItemMemberships | SalesItemMemberships |
None. |
|
SalesItemOptionMemberships | SalesItemOptionMemberships |
None. |
|
DefaultOptions | DefaultOptions |
None. |
|
SiteGroupPriceOverrides | SiteGroupPriceOverrides |
None. |
|
SiteGroupModifierPriceOverrides | SiteGroupModifierPriceOverrides |
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 } ], "PriceOverrides": { "$id": "4", "Columns": [ "sample string 7", "sample string 8" ], "Data": [ [ { "$id": "5" }, { "$id": "6" } ], [ { "$id": "7" }, { "$id": "8" } ] ] }, "SalesItemOptionPriceOverrides": { "$id": "9", "Columns": [ "sample string 13", "sample string 14" ], "Data": [ [ { "$id": "10" }, { "$id": "11" } ], [ { "$id": "12" }, { "$id": "13" } ] ] }, "MenuMemberships": { "$id": "14", "Columns": [ "sample string 19", "sample string 20" ], "Data": [ [ { "$id": "15" }, { "$id": "16" } ], [ { "$id": "17" }, { "$id": "18" } ] ] }, "SubMenuMemberships": { "$id": "19", "Columns": [ "sample string 25", "sample string 26" ], "Data": [ [ { "$id": "20" }, { "$id": "21" } ], [ { "$id": "22" }, { "$id": "23" } ] ] }, "MenuItemMemberships": { "$id": "24", "Columns": [ "sample string 31", "sample string 32" ], "Data": [ [ { "$id": "25" }, { "$id": "26" } ], [ { "$id": "27" }, { "$id": "28" } ] ] }, "SalesItemMemberships": { "$id": "29", "Columns": [ "sample string 37", "sample string 38" ], "Data": [ [ { "$id": "30" }, { "$id": "31" } ], [ { "$id": "32" }, { "$id": "33" } ] ] }, "SalesItemOptionMemberships": { "$id": "34", "Columns": [ "sample string 43", "sample string 44" ], "Data": [ [ { "$id": "35" }, { "$id": "36" } ], [ { "$id": "37" }, { "$id": "38" } ] ] }, "DefaultOptions": { "$id": "39", "Columns": [ "sample string 49", "sample string 50" ], "Data": [ [ { "$id": "40" }, { "$id": "41" } ], [ { "$id": "42" }, { "$id": "43" } ] ] }, "SiteGroupPriceOverrides": { "$id": "44", "Columns": [ "sample string 55", "sample string 56" ], "Data": [ [ { "$id": "45" }, { "$id": "46" } ], [ { "$id": "47" }, { "$id": "48" } ] ] }, "SiteGroupModifierPriceOverrides": { "$id": "49", "Columns": [ "sample string 61", "sample string 62" ], "Data": [ [ { "$id": "50" }, { "$id": "51" } ], [ { "$id": "52" }, { "$id": "53" } ] ] } }
application/xml, text/xml
Sample:
<SiteOverridesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response"> <CurrentOffset>1</CurrentOffset> <DefaultOptions> <Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 49</d3p1:string> <d3p1:string>sample string 50</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> </DefaultOptions> <MenuItemMemberships> <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> </MenuItemMemberships> <MenuMemberships> <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> </MenuMemberships> <PriceOverrides> <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> </PriceOverrides> <SalesItemMemberships> <Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 37</d3p1:string> <d3p1:string>sample string 38</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 43</d3p1:string> <d3p1:string>sample string 44</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> <SalesItemOptionPriceOverrides> <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> </SalesItemOptionPriceOverrides> <SiteGroupModifierPriceOverrides> <Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 61</d3p1:string> <d3p1:string>sample string 62</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> </SiteGroupModifierPriceOverrides> <SiteGroupPriceOverrides> <Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 55</d3p1:string> <d3p1:string>sample string 56</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> </SiteGroupPriceOverrides> <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 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> </SubMenuMemberships> <TotalCount>2</TotalCount> </SiteOverridesResult>