GetBrands

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

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
Brands Array of Brand — Brands for this location.
Brand Properties
- Id int — Unique Id of this Brand
- Name string — Name of the Brand

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetBrands request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetBrands

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetBrandsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <GetBrandsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Brands>
          <Brand>
            <Id>1</Id>
            <Name>Main Brand</Name>
          </Brand>
        </Brands>
      </GetBrandsResult>
    </GetBrandsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Brand objects.