GetModifierCodes

This call is to retrieve an array of ModifierCode 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
ModifierCodes Array of ModifierCode — Array of ModifierCode objects for this location.
ModifierCode Properties
- Abbreviation string — Abbreviation for this ModifierCode
- Active bool — True if this ModifierCode is active, False if inactive
- AppliesTo ModCodeIngredientType — Returns one of the following: Ingredients, NonIngredients, Both
- ChargeType ModCodeChargeType — Returns one of the following:
  - Undefined
  - Always
  - ChargeForNonIngredients
  - Never
  - UseModifierTiers
  - ModifierCodePricing
- Id int — Unique Id of this ModifierCode
- IsDeleted bool — True if ModifierCode is deleted, False if not
- IsSystem bool — Default is False (deprecated)
- ModifierCodePricingAppliesTo ModCodePricingIngredientType — Returns one of the following:
  - IngredientsAndNonIngredients
  - NonIngredientsOnly
- Name string — Name of this ModifierCode
- Type ModCodeType — Returns one of the following: Normal, No, For, Sub, OnSide

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetModifierCodes request with accessToken and locationToken in body.

Responses

text/xml; charset=utf-8

post/GetModifierCodes

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetModifierCodesResponse xmlns="http://tempuri.org/">
      <Settings_GetModifierCodesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <ModifierCodes>
          <ModifierCode>
            <Abbreviation>XL</Abbreviation>
            <Active>true</Active>
            <AppliesTo>Ingredients</AppliesTo>
            <ChargeType>Normal</ChargeType>
            <Id>10</Id>
            <IsDeleted>false</IsDeleted>
            <IsSystem>false</IsSystem>
            <ModifierCodePricingAppliesTo>Ingredients</ModifierCodePricingAppliesTo>
            <Name>Extra Light</Name>
            <Type>0</Type>
          </ModifierCode>
        </ModifierCodes>
      </Settings_GetModifierCodesResult>
    </Settings_GetModifierCodesResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of ModifierCode objects.