getSchedule

Returns employee's work schedule. It can be retrieved in two formats: a list of employee's working hours for each day, or a list of employee's time off.

This API call can only be used is Salon module is enabled on your account. For other salon related functions, see getEmployees and getTimeSlots.

Input parameters

Parameter name Description Possible value Required
dateFrom  beginning of the date interval for which you want to retrieve schedule  ISO date (yyyy-mm-dd)  yes  
dateUntil  end of the date interval for which you want to retrieve schedule  ISO date (yyyy-mm-dd)  yes  
warehouseID  Location, salon ID  integer    
employeeID  Employee ID. If not set, all employees in this location will be returned.  Integer    
showTimeOff  If set to 1, API will return a list of times when employee is NOT at work. If set to 0 or unset, API will return a list of times when employee IS at work.      
calendarStartTime
calendarEndTime 
If you need to lay out a calendar visually and display the times when employee is NOT at work, you might want to only display those intervals that fall within the time period depicted in your calendar.

For example, if your calendar is laid out from 8am to 9pm, set calendarStartTime to 8:00:00 and calendarEndTime to 21:00:00. If on that day, employee will be working from 10am to 6pm and you want to retrieve times off, API will return two records: 8am-10am and 6pm-9pm. 
ISO time (hh:mm:ss)    

Response

Field name Type Description
startTime  ISO datetime (yyyy-mm-dd hh:mm:ss)    
endTime  ISO datetime (yyyy-mm-dd hh:mm:ss)    
employeeID  Integer    
employeeName  String    
warehouseID  Integer