SaveExceptionDates

Create or update the existing exception dates of a location. Please do not keep batch size of more than 100.

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.
ExceptionDates Array of ExceptionDate — Specify one or more ExceptionDates objects you would like to create.
ExceptionDate Properties
- CloseTime TimeSpan? — The close time for this exception date
- Date DateTime — The date at which this current exception is triggered upon
- Id DateTime — Unique Id of this ExceptionDate
- IsOpen bool — Whether or not the location is open at the given date. If this value is false, the OpenTime and CloseTime are null
- Name string — Name of this ExceptionDate
- OpenTime TimeSpan? — The open time at which this current exception begins

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 SaveExceptionDatesResult — Contains details on whether or not the request has succeeded.
SaveExceptionDatesResult Properties
- Id int — The new generated Id of a specific entity in the SaveExceptionDates request
- OriginalId int — The original Id of a specific entity passed into the SaveExceptionDates request
- ValidationMessages List<string> — Details if the request was unsuccessful

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for SaveExceptionDates request containing exception date entries.

Responses

text/xml; charset=utf-8

post/SaveExceptionDates

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?SaveExceptionDates' \
  --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/SaveExceptionDates"' \
  --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:SaveExceptionDates>
        <v2:request>
          <v2:BusinessDate>2024-01-15</v2:BusinessDate>
          <v2:ChangesetName>HolidayClosures</v2:ChangesetName>
          <v2:IsImmediatePublish>false</v2:IsImmediatePublish>
          <v2:ExceptionDates>
            <v2:ExceptionDate>
              <v2:Id>-1</v2:Id>
              <v2:Name>Christmas Day</v2:Name>
              <v2:Date>2024-12-25</v2:Date>
              <v2:IsOpen>false</v2:IsOpen>
            </v2:ExceptionDate>
          </v2:ExceptionDates>
        </v2:request>
      </v2:SaveExceptionDates>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <SaveExceptionDatesResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <SaveExceptionDatesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <SaveResults>
          <SaveExceptionDatesResult>
            <Id>12345</Id>
            <OriginalId>-1</OriginalId>
            <ValidationMessages/>
          </SaveExceptionDatesResult>
        </SaveResults>
      </SaveExceptionDatesResult>
    </SaveExceptionDatesResponse>
  </s:Body>
</s:Envelope>

SOAP response with Message and ResultCode (0 = success).