GetShifts

Retrieve an array of Shift objects for the location.

Request Parameters

BusinessDate DateTime — Specify the business date for which you would like to see the shifts worked.
ModifiedTime DateTimeOffset — (optional) When specified, only shifts that have been modified on or after the specified time will be retrieved. This compares against any edited shifts on the Register time.

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
Shifts Array of Shift — Shifts worked on this business date.
Shift Properties
- Breaks Array of Break — Breaks for this Shift
  Break Properties
  - EndTime DateTimeOffset — End time of this Break
  - Minutes int — Minutes of this paid Break (unpaid Breaks not included)
  - Number byte — Incremental count of the employee's Breaks for a particular business date. (e.g. Returns a "1" for first break of the day, "2" for second, etc.)
  - IsPaid bool — True if this is paid Break, False if not
  - StartTime DateTimeOffset — Start time of this Break
- BusinessDate DateTime — Business date of this Shift (the time component will always return as 00:00:00)
- ClockOutBusinessDate DateTime — Business date on which this Shift was clocked out (the time component will always return as 00:00:00)
- DeclaredTips decimal — Tips declared for this Shift
- EmployeeId int — Maps to the Id of the Employee for this Shift
- EndTime DateTimeOffset — End time of this Shift
- ExtendedMinutesWorked int — Amount of minutes worked for this Shift outside of regular working hours, to be paid at a regular pay rate
- Id Guid — Unique Id of this Shift
- JobId int — Maps to the Id of the Job for this Shift
- MinutesWorked int — Amount of total minutes worked for this Shift
- ModifiedTime DateTimeOffset — Date and time of the last time this Shift was modified (e.g. by a clock in/out or break event)
- Number byte — Incremental count of the employee's Shifts for a particular business date. (e.g. Returns a "1" for first shift of the day, "2" for second, etc.)
- OvertimeMinutesWorked int — Amount of minutes worked for this Shift in overtime, to be paid at an overtime pay rate
- PayRate decimal — Payrate that was current for the job at the time of this Shift
- RegularMinutesWorked int — Amount of minutes worked for this Shift within regular working hours, to be paid at a regular pay rate
- StartTime DateTimeOffset — Start time of this Shift

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetShifts request with BusinessDate.

Responses

text/xml; charset=utf-8

post/GetShifts

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Labor2.svc?GetShifts' \
  --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/labor/v2/ILaborWebService2/GetShifts"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/labor/v2"
    xmlns:sys="http://schemas.datacontract.org/2004/07/System">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetShifts>
        <v2:request>
          <v2:BusinessDate>2024-01-15</v2:BusinessDate>
        </v2:request>
      </v2:GetShifts>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetShiftsResponse xmlns="http://www.brinksoftware.com/webservices/labor/v2">
      <GetShiftsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Shifts>
          <Shift>
            <Id>cccccccc-0000-0000-0000-000000000003</Id>
            <EmployeeId>123</EmployeeId>
            <JobId>456</JobId>
            <BusinessDate>2024-01-15T00:00:00</BusinessDate>
            <StartTime>2024-01-15T09:00:00-06:00</StartTime>
            <EndTime>2024-01-15T17:00:00-06:00</EndTime>
            <MinutesWorked>480</MinutesWorked>
            <RegularMinutesWorked>480</RegularMinutesWorked>
            <OvertimeMinutesWorked>0</OvertimeMinutesWorked>
            <Number>1</Number>
            <Breaks>
              <Break>
                <StartTime>2024-01-15T12:00:00-06:00</StartTime>
                <EndTime>2024-01-15T12:30:00-06:00</EndTime>
                <Minutes>30</Minutes>
                <Number>1</Number>
                <IsPaid>false</IsPaid>
              </Break>
            </Breaks>
          </Shift>
        </Shifts>
      </GetShiftsResult>
    </GetShiftsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Shift objects.