GetModifierGroups

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

Request Parameters

accessToken string — Your access token (passed in SOAP body, not headers).
locationToken string — Your location token (passed in SOAP body, not headers).

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 — Success
- 1 — Unknown Error
- 3 — Server Unavailable
- 4 — Access Denied
ModifierGroups Array of ModifierGroup — Array of ModifierGroup objects for this location.
ModifierGroup Properties
- 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
  - ItemId int — Maps to the Id of the Item in this ModifierGroup
  - Position short — Display position of this item within the ModifierGroup
  - Price decimal — Price of this modifier item
  - PriceMethod byte — Returns one of the following: 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 containing the GetModifierGroups request with accessToken and locationToken in body.

Responses

text/xml; charset=utf-8

post/GetModifierGroups

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings.svc?Settings_GetModifierGroups' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'SOAPAction: "http://tempuri.org/ISettingsWebService/GetModifierGroups"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
      <tem:GetModifierGroups>
        <tem:accessToken>AccessToken</tem:accessToken>
        <tem:locationToken>LocationToken</tem:locationToken>
      </tem:GetModifierGroups>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetModifierGroupsResponse xmlns="http://tempuri.org/">
      <Settings_GetModifierGroupsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <ModifierGroups>
          <ModifierGroup>
            <AlternateId>MODGRP-001</AlternateId>
            <Description>Choose your toppings</Description>
            <DisplayName>Toppings</DisplayName>
            <FlowRequired>false</FlowRequired>
            <Free>1</Free>
            <FreeModifierLimit>0</FreeModifierLimit>
            <Id>7</Id>
            <IsActive>true</IsActive>
            <IsDeleted>false</IsDeleted>
            <IsSystem>false</IsSystem>
            <Items>
              <ModifierGroupItem>
                <ItemId>201</ItemId>
                <Position>1</Position>
                <Price>0.50</Price>
                <PriceMethod>0</PriceMethod>
              </ModifierGroupItem>
            </Items>
            <Maximum>3</Maximum>
            <Minimum>0</Minimum>
            <Name>Toppings</Name>
            <PanelId>1</PanelId>
          </ModifierGroup>
        </ModifierGroups>
      </Settings_GetModifierGroupsResult>
    </Settings_GetModifierGroupsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of ModifierGroup objects.