GetItemGroups

This call is to retrieve an array of ItemGroup 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
ItemGroups Array of ItemGroup — Array of ItemGroup objects for this location.
ItemGroup Properties
- AlternateId string — Optional alternate identifier for this ItemGroup
- Id int — Unique Id of this ItemGroup
- IsDeleted bool — True if this ItemGroup has been deleted, False if not
- Items Array of ItemGroupItem — Items contained in this ItemGroup
  ItemGroupItem Properties
  - ItemId int — Maps to the Id of the Item that belongs to this ItemGroup
- Name string — Name of this ItemGroup

Headers

SOAPAction
Type: string
required

Body

required

application/json

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

Responses

text/xml; charset=utf-8

post/GetItemGroups

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetItemGroupsResponse xmlns="http://tempuri.org/">
      <Settings_GetItemGroupsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <ItemGroups>
          <ItemGroup>
            <AlternateId>IG-001</AlternateId>
            <Id>2</Id>
            <IsDeleted>false</IsDeleted>
            <Items>
              <ItemGroupItem>
                <ItemId>101</ItemId>
              </ItemGroupItem>
              <ItemGroupItem>
                <ItemId>102</ItemId>
              </ItemGroupItem>
            </Items>
            <Name>Beverages</Name>
          </ItemGroup>
        </ItemGroups>
      </Settings_GetItemGroupsResult>
    </Settings_GetItemGroupsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of ItemGroup objects.