SaveModifierGroups

Create new modifier groups or update the existing modifier groups details.

Request Parameters

BusinessDate DateTime? — The BusinessDate from when the change should apply. Default is the current BusinessDate of the location.
IsImmediatePublish bool — Whether or not the change should be applied immediately (will restart all registers at the location).
ChangesetName string — Optionally provide a custom "changeset" name. If the value is not passed, a default "changeset" name is created.
ModifierGroups Array of ModifierGroup — Specify one or more ModifierGroup objects you would like to create.
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
  - 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

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
- 2 — Invalid Request
- 3 — Server Unavailable
- 4 — Access Denied
SaveResults Array of SaveModifierGroupsResult — Contains details on whether or not the request has succeeded.
SaveModifierGroupsResult Properties
- Id int — The new generated Id of a specific entity in the SaveModifierGroups request
- OriginalId int — The original Id of a specific entity passed into the SaveModifierGroups request
- ValidationMessages List<string> — Details if the request was unsuccessful

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for SaveModifierGroups request containing modifier group details.

Responses

text/xml; charset=utf-8

post/SaveModifierGroups

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?SaveModifierGroups' \
  --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/SaveModifierGroups"' \
  --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:SaveModifierGroups>
        <v2:request>
          <v2:ModifierGroups>
            <v2:ModifierGroup>
              <v2:Id>-1</v2:Id>
              <v2:Name>Burger Toppings</v2:Name>
              <v2:Minimum>0</v2:Minimum>
              <v2:Maximum>5</v2:Maximum>
            </v2:ModifierGroup>
          </v2:ModifierGroups>
        </v2:request>
      </v2:SaveModifierGroups>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <SaveModifierGroupsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <SaveModifierGroupsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <SaveResults>
          <SaveModifierGroupsResult>
            <Id>10</Id>
            <OriginalId>0</OriginalId>
            <ValidationMessages/>
          </SaveModifierGroupsResult>
        </SaveResults>
      </SaveModifierGroupsResult>
    </SaveModifierGroupsResponse>
  </s:Body>
</s:Envelope>

SOAP response with SaveResults containing new IDs or validation errors.