GetBusinessHours

This call is to retrieve the business hours for a location along with any exceptions.

Request Parameters

StartDate DateTime? — Used to find exception dates greater than this date if specified.
EndDate DateTime? — Used to find exception dates less than this date if specified.

Response Parameters

LocationOptions LocationOptions — Contains information on BusinessHours and ExceptionDates
LocationOptions Properties
- BusinessHours IEnumerable<BusinessHour> — A collection that contains time-related information of each business BusinessHours
  BusinessHour Properties
  - CloseTime TimeSpan? — The end time of the store on the given day
  - DayOfWeek DayOfWeek — One of the days of the week (Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday)
  - Id int — Unique Id of this BusinessHour
  - OpenTime TimeSpan? — The open time of the store on the given day
- ExceptionDates IEnumerable<ExceptionDate> — A collection of dates that contains days when the location may have different hours or is closed
  ExceptionDate Properties
  - CloseTime TimeSpan? — Close time on this exception date (null if closed all day)
  - Date DateTime — The exception date
  - Id int — Unique Id of this ExceptionDate
  - IsOpen bool — True if the location is open on this exception date, False if closed
  - OpenTime TimeSpan? — Open time on this exception date (null if closed all day)
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 = Request went through successfully
- 1 = Request returned an unknown error
- 2 = Request was not valid
- 3 = Server is currently unavailable and unable to receive the request
- 4 = Access Denied

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetBusinessHours request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetBusinessHours

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetBusinessHoursResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <GetBusinessHoursResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <BusinessHours>
          <BusinessHour>
            <CloseTime>PT22H</CloseTime>
            <DayOfWeek>Monday</DayOfWeek>
            <OpenTime>PT9H</OpenTime>
          </BusinessHour>
        </BusinessHours>
        <ExceptionDates>
          <ExceptionDate>
            <CloseTime i:nil="true"/>
            <Date>2024-12-25T00:00:00</Date>
            <IsOpen>false</IsOpen>
            <OpenTime i:nil="true"/>
          </ExceptionDate>
        </ExceptionDates>
      </GetBusinessHoursResult>
    </GetBusinessHoursResponse>
  </s:Body>
</s:Envelope>

SOAP response containing BusinessHour and ExceptionDate objects.