GetMenu

This call is to retrieve a Menu object for the location.

Request Parameters

MenuId int — Specify the Id of the Menu you would like to retrieve

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
ResultCode int — Returns one of the following:
- 0 = Request went through successfully
- 1 = Request returned an unknown error
- 2 = Request was not valid
- 3 = Server is currently unavailable and unable to receive the request
- 4 = Access Denied
Menu Menu — Menu with the MenuId you specified, if one is found
Menu Properties
- Categories Array of MenuCategory — Categories in this Menu
  MenuCategory Properties
  - Description string — Description of this MenuCategory
  - Id int — Unique Id of this MenuCategory
  - Items Array of MenuItem — Items in this MenuCategory
    
    MenuItem Properties
    
    Description string — Description of this MenuItem
    
    Id int — Unique Id of this MenuItem
    
    ImageId int — Id of the Image for this MenuItem
    
    ItemId int — Maps to the Id of the Item for this MenuItem
    
    ItemOptions(Exposed Only in GetSettings) Array of MenuItemOption — Item options for this MenuItem
    
    MenuItemOption Properties
    
    DisplayName string — Display name of this MenuItemOption
    
    Id int — Unique Id of this MenuItemOption
    
    ItemId int — Maps to the Id of the Item for this MenuItemOption
    
    SortOrderId(Exposed Only in GetSettings) short — Sort order of this MenuItemOption within the parent MenuItem
    
    ModifierGroups(Exposed Only in GetSettings) Array of MenuItemModifierGroup — Modifier groups for this MenuItem
    
    MenuItemModifierGroup Properties
    
    Id int — Unique Id of this MenuItemModifierGroup
    
    ModifierGroupId int — Maps to the Id of the ModifierGroup for this MenuItemModifierGroup
    
    SortOrderId(Exposed Only in GetSettings) short — Sort order of this MenuItemModifierGroup within the parent MenuItem
    
    ModifierMethod byte — Modifier method for this MenuItem
    
    Name string — Name of this MenuItem
    
    Price decimal — Price of this MenuItem
    
    PriceMethod byte — Price method for this MenuItem
    
    SortOrderId(Exposed Only in GetSettings) short — Sort order of this MenuItem within the parent MenuCategory
  - Name string — Name of this MenuCategory
  - SortOrderId(Exposed Only in GetSettings) int — Sort order of this MenuCategory within the parent Menu
- Description string — Description of this Menu
- Id int — Unique Id of this Menu
- ImageId int — Id of the Image for this Menu
- Name string — Name of this Menu

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetMenu request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetMenu

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetMenu' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/settings/v2/ISettingsWebService2/GetMenu"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetMenu/>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings2_GetMenuResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <Settings2_GetMenuResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Menu>
          <Categories>
            <MenuCategory>
              <Description>Delicious burgers and sandwiches</Description>
              <Id>1</Id>
              <Items>
                <MenuItem>
                  <Description>Classic beef burger</Description>
                  <ImageId>101</ImageId>
                  <ItemId>1001</ItemId>
                  <ItemOptions>
                    <MenuItemOption>
                      <DisplayName>Add Bacon</DisplayName>
                      <ItemId>2001</ItemId>
                      <SortOrderId>1</SortOrderId>
                    </MenuItemOption>
                  </ItemOptions>
                  <ModifierGroups>
                    <MenuItemModifierGroup>
                      <ModifierGroupId>10</ModifierGroupId>
                      <SortOrderId>1</SortOrderId>
                    </MenuItemModifierGroup>
                  </ModifierGroups>
                  <ModifierMethod>0</ModifierMethod>
                  <Name>Classic Burger</Name>
                  <Price>9.99</Price>
                  <PriceMethod>0</PriceMethod>
                  <SortOrderId>1</SortOrderId>
                </MenuItem>
              </Items>
              <Name>Burgers</Name>
              <SortOrderId>1</SortOrderId>
            </MenuCategory>
          </Categories>
          <Description>Main Menu</Description>
          <Id>1</Id>
          <ImageId>0</ImageId>
          <Name>Main Menu</Name>
        </Menu>
      </Settings2_GetMenuResult>
    </Settings2_GetMenuResponse>
  </s:Body>
</s:Envelope>

SOAP response containing a Menu object with categories and items.