GetVoidReasons

This call is to retrieve an array of VoidReason 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
VoidReasons Array of VoidReason — Array of VoidReason objects for this location.
VoidReason Properties
- Id int — Unique Id of this VoidReason
- Name string — Name of this VoidReason

Headers

SOAPAction
Type: string
required

Body

required

application/json

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

Responses

text/xml; charset=utf-8

post/GetVoidReasons

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetVoidReasonsResponse xmlns="http://tempuri.org/">
      <Settings_GetVoidReasonsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <VoidReasons>
          <VoidReason>
            <Id>1</Id>
            <Name>Customer Changed Mind</Name>
          </VoidReason>
        </VoidReasons>
      </Settings_GetVoidReasonsResult>
    </Settings_GetVoidReasonsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of VoidReason objects.