SaveLaborSchedule

Save a labor schedule of scheduled shifts for the location for one or more days.

Request Parameters

LaborSchedule LaborSchedule — Specify the labor schedule you would like to save for this location.
LaborSchedule Properties
- Days Array of LaborScheduleDay — Labor schedule for a date range
  LaborScheduleDay Properties
  - BusinessDate DateTime — Business date for this LaborScheduleDay (the time component will always return as 00:00:00)
  - Shifts Array of ScheduledShift — Scheduled shifts for this LaborScheduleDay
    
    ScheduledShift Properties
    
    EmployeeId int — Maps to the Id of the Employee for this ScheduledShift
    
    EndTime TimeSpan — End time of this ScheduledShift
    
    JobId int — Maps to the Id of the Job for this ScheduledShift
    
    StartTime TimeSpan — Start time of this ScheduledShift

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
EmployeeId int — (optional) Populated with an Employee Id if the request is invalid, e.g. if the employee has been terminated or in the case of an invalid JobId listed for an employee. Otherwise, this field will be null.
JobId int — (optional) Populated with a Job Id if the request is invalid, e.g. in the case of there is an invalid JobId listed for an employee. Otherwise, this field will be null.
ValidationMessages Array of string — Details if the request was unsuccessful.

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the SaveLaborSchedule request with a LaborSchedule object.

Responses

text/xml; charset=utf-8

post/SaveLaborSchedule

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Labor2.svc?SaveLaborSchedule' \
  --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/SaveLaborSchedule"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/labor/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:SaveLaborSchedule>
        <v2:request>
          <v2:LaborSchedule>
            <v2:Days>
              <v2:LaborScheduleDay>
                <v2:BusinessDate>2024-01-15</v2:BusinessDate>
                <v2:Shifts>
                  <v2:ScheduledShift>
                    <v2:EmployeeId>123</v2:EmployeeId>
                    <v2:JobId>456</v2:JobId>
                    <v2:StartTime>PT09H</v2:StartTime>
                    <v2:EndTime>PT17H</v2:EndTime>
                  </v2:ScheduledShift>
                </v2:Shifts>
              </v2:LaborScheduleDay>
            </v2:Days>
          </v2:LaborSchedule>
        </v2:request>
      </v2:SaveLaborSchedule>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <SaveLaborScheduleResponse xmlns="http://www.brinksoftware.com/webservices/labor/v2">
      <SaveLaborScheduleResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <EmployeeId/>
        <JobId/>
        <ValidationMessages/>
      </SaveLaborScheduleResult>
    </SaveLaborScheduleResponse>
  </s:Body>
</s:Envelope>

SOAP response with validation results.