GetOnlineOrderingMenuOptions

This call is to retrieve an array of AlternateMenu objects and/or an OnlineOrderingMenuId for the location.

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
AlternateMenus Array of AlternateMenu — Alternate menus for this location
AlternateMenu Properties
- Days byte? — Days of the week this AlternateMenu is active (binary-encoded: 1=Sun, 2=Mon, 4=Tue, 8=Wed, 16=Thu, 32=Fri, 64=Sat)
- EndTime TimeSpan — End time of this AlternateMenu
- Id int — Unique Id of this AlternateMenu
- MenuId int — Maps to the Id of the Menu for this AlternateMenu
- StartTime TimeSpan — Start time of this AlternateMenu
- TimeType byte — 0=RequestedTime, 1=CalculatedSendTime
OnlineOrderingMenuId int? — Id for the default Online Ordering Menu

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetOnlineOrderingMenuOptions request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetOnlineOrderingMenuOptions

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetOnlineOrderingMenuOptions' \
  --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/GetOnlineOrderingMenuOptions"' \
  --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:GetOnlineOrderingMenuOptions/>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetOnlineOrderingMenuOptionsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <GetOnlineOrderingMenuOptionsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <AlternateMenus>
          <AlternateMenu>
            <Days>62</Days>
            <EndTime>PT17H0M0S</EndTime>
            <Id>1</Id>
            <MenuId>2</MenuId>
            <StartTime>PT11H0M0S</StartTime>
            <TimeType>0</TimeType>
          </AlternateMenu>
        </AlternateMenus>
        <OnlineOrderingMenuId>2</OnlineOrderingMenuId>
      </GetOnlineOrderingMenuOptionsResult>
    </GetOnlineOrderingMenuOptionsResponse>
  </s:Body>
</s:Envelope>

SOAP response with online ordering menu configuration.