GetLabor - Details

The GetLabor method returns labor data for a specified hotel id and date range.  There are different kinds of labor data organized by a datatypecode.  This can be actual labor (1), realtime standard labor (2), forecast standard labor (3), and scheduled shifts (6).  Each has a corresponding code that can be passed in as a parameter in the call, ie. 1, 2 would return actual and realtime standard labor data in the same response.

Parameters

There are four required parameters for this method:

• locationid - Six digit unique Hotel Effectiveness hotel id, i.e. 104609
• startdate - Start date of your requested data range in YYYY-MM-DD format
• enddate - End date of your requested data range in YYYY-MM-DD format
• datatype - Numerical code for the type of data in your request, i.e. 1 or 6.  You can request multiple types in the same call by separating them by a comma with no spaces, i.e. 1,2 for actuals and labor standards

There are three optional parameters for this method:

• salariedfilter - Blank returns all, 1 is salaried employees only, 0 is hourly employees only
• contractorfilter - Blank returns all, 1 is contractors only, 0 is non contractors only
• schedstatusfilter - 0 = Pending, 1 = Published, 3=Denied, enter 1 or more, separated by a comma, ie. 0,1

Authentication

You must send your Username and Password as basic headers in your request.

Sample Call

Below is a sample for pulling actuals and labor standards for one hotel for a given date range

https://data.hoteleffectiveness.com/LaborManagement.svc/GetLabor?locationid=104609&startdate=2014-01-10&enddate=2014-01-10&datatype=1,2

Response Data Definition

Below is a listing and details of every field that is returned via the Labor DataMiner & accessible through the API access .

Status - API Result Status, it will be SUCCESS or ERROR
Status_Description - API Result Description. Blank for Success, details if an error
paramlocationid - Locationid that was sent in the original request, same for every record returned
paramstartdate - Start Date that was sent in the original request, same for every record returned
paramenddate - End Date that was sent in the original request, same for every record returned
paramdatatype - Data Type Filter that was sent in the original request, same for every record returned
paramoptional - Optional Filters that were sent in the original request, same for every record returned
locationid - Unique location id of a hotel in Hotel Effectiveness
hotelname - Hotel Name stored in Hotel Effectiveness
datatypecode - Data Type code indicates what kind of data it is, 1 = Actual Labor, 2 = Realtime Standard Labor, 3 = Forecast Standard Labor, 6 = Scheduled Shifts
datatypename - Name of the Data Type
date - Date associated with the Labor. This can be the punch date or the date of the schedules.
eeid1 - Unique employee id in Hotel Effectiveness. This is generated by Hotel Effectiveness
eeid2 - Hotel employee id. This is probably their payroll id or the employee code.
eename1 - Last and First name of the employee. Plan records may not be specific to an employee and this may be blank
contractorind - Contractor Indicator. 1 = Yes a Contractor, 0 = No, not a Contractor
salariedind - Salaried Indicator. 1 = Salaried, 0 = Hourly
division - Division from the Hotel Department Setup. This is the Division tagged to the labor based on the position.
dept - Department from the Hotel Department Setup. This is the Department tagged to the labor based on the position.
positionname - Position name. This is the standard position name in Hotel Effectiveness
positioncode - Position Code. This is a unique six character code for a specific position.
category - Labor Category/Earnings Code. This can be Regular, Overtime, PTO, Vacation, etc
winlossind - Win Loss indicator tells the system whether to include (1) or exclude (0) in the Labor Management Tools. Only 1's should be included to tie back to Realtime reports.
plantype - Name of the plan type that was used, if pulling scheduled shifts this will display schedule status (pending, published, or denied), blank for actual data
planname - Name of the plan name or budget assumptions, blank for most records
startdatetime - Timestamp of the in punch/shift
stopdatetime - Timestamp of the out punch/shift
lunchminutes - Number of break/lunch minutes that are unpaid. These are already reflected in the net hours of the labor record. They are just informational. Typically 0 unless you have this setup in Time & Attendance or use breaks in Scheduler.
hours - Hours for the labor record. These are defaulted for 5.71 for salaried employees.
wages - Wages for the labor record. They are fully extended based on the applied rate and hours.
lastchangedtime - Timestamp that the labor data was last modified or refreshed