GetModifierGroups

This call is to retrieve an array of ModifierGroups for the location.

Response Parameters

Description string — Description of this ModifierGroup
DisplayName string — Display name for this ModifierGroup
FlowRequired bool — True if flow required, False if not
Free byte — Number of free modifiers within this ModifierGroup allowed before charged
Id int — Unique Id of this ModifierGroup
IsDeleted bool — True if ModifierGroup is deleted, False if not
Items Array of ModifierGroupItem — Modifier group items in this ModifierGroup
ModifierGroupItem Properties
- Id int — Unique Id of this ModifierGroupItem within the ModifierGroup
- ItemId int — Maps to the Id of the Item of this ModifierGroupItem
- Position short — Position of this ModifierGroupItem within the ModifierGroup
- Price decimal — Price of this ModifierGroupItem
- PriceMethod ModifierPriceMethod — 0=ItemPrice, 1=ModifierPrice
Maximum byte — Maximum number of modifiers allowed from this ModifierGroup
Minimum byte — Minimum number of modifiers allowed from this ModifierGroup
Name string — Name of this ModifierGroup
PanelId int — Panel Id for this ModifierGroup

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetModifierGroups request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetModifierGroups

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetModifierGroupsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <GetModifierGroupsResult>
        <Collection>
          <ModifierGroup>
            <AllowSubstitutionAcrossGroups>false</AllowSubstitutionAcrossGroups>
            <Description>Choose your burger toppings</Description>
            <DisplayName>Toppings</DisplayName>
            <Free>2</Free>
            <Id>10</Id>
            <IsDeleted>false</IsDeleted>
            <IsFlowRequired>false</IsFlowRequired>
            <Items>
              <ModifierGroupItem>
                <Id>101</Id>
                <ItemId>5001</ItemId>
                <Position>1</Position>
                <Price>0.50</Price>
                <PriceMethod>ModifierPrice</PriceMethod>
              </ModifierGroupItem>
              <ModifierGroupItem>
                <Id>102</Id>
                <ItemId>5002</ItemId>
                <Position>2</Position>
                <Price>0.00</Price>
                <PriceMethod>ItemPrice</PriceMethod>
              </ModifierGroupItem>
            </Items>
            <Maximum>5</Maximum>
            <Minimum>0</Minimum>
            <Name>Burger Toppings</Name>
            <PanelId>1</PanelId>
          </ModifierGroup>
        </Collection>
      </GetModifierGroupsResult>
    </GetModifierGroupsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of ModifierGroup objects.