The Context
- This dataset provides a list of employees in the labor management system for a specified hotel ID, allowing you to filter for several different segments of the employee population. These fields are returned via the Employee DataMiner and are accessible through API access.
- Additional field items can be configured to display in this dataset. These configurable fields can be found by navigating to Settings > Employee Manager tab > Additional Employee Information Items. (Note: Select here to learn how to add or change the Additional Employee Information item).
Parameters
There are six required parameters for this method:
- Location ID - Six digit unique Hotel Effectiveness hotel id, i.e. 104609
- Active as of Date - You can remove this to show all active and inactive employees or set it to any date. mm/dd/yyyy
- Hire Start Date - You can use this in conjunction with the Hire End Date to filter all new hires between two dates, i.e. All of April (4/1 to 4/30) mm/dd/yyyy
- Hire End Date - This must be entered for the Hire Date filter to work. mm/dd/yyyy
- Term Start Date - You can use this in conjunction with the Term End Date to filter all new terms between two dates, i.e. All of April (4/1 to 4/30) mm/dd/yyyy
- Term End Date - This must be entered for the Term Date filter to work. mm/dd/yyyy
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
The Data
Field Name |
Definition |
|---|---|
Status |
API Result Status; it will return as SUCCESS or ERROR. |
Status_Description |
API Result Description. Leaves blank for Success, or provides details if an error occurs. |
paramlocationid |
Location ID that was sent in the original request (same for every record returned). |
paramactiveasofdate |
Active Date that was sent in the original request (same for every record returned). |
paramhirestartdate |
Start Date that was sent in the original request (same for every record returned). |
paramhireenddate |
End Date 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). |
locationid |
Unique location ID of a hotel stored in Hotel Effectiveness. |
hotelname |
Hotel Name stored in Hotel Effectiveness. |
eeid1 |
Unique employee ID generated by Hotel Effectiveness. |
eeid2 |
Hotel employee ID (likely their payroll ID or the employee code). |
card1 |
Card 1 field in Time & Attendance (often the user ID for clocking in and out). |
web1 |
Web password in Time & Attendance (often only used for webclock employees). |
lastname |
Last name of the employee. |
firstname |
First name of the employee. |
hiredate |
Hire date of the employee. |
termdate |
Termination date of the employee. |
homedivision |
Division from the Hotel Department Setup (tagged to the labor based on the position). |
homedept |
Department from the Hotel Department Setup (tagged to the labor based on the position). |
homeposition |
Position name (the standard position name in Hotel Effectiveness). |
homepositioncode |
Position Code (a unique six-character code for a specific position). |
contractorind |
Contractor Indicator (1 = Yes a Contractor, 0 = No, not a Contractor). |
salariedind |
Salaried Indicator (1 = Salaried, 0 = Hourly). |
baserate |
Employee's base rate of pay. |
eep_username |
Employee's myHotelTeam user name. |
eep_status_name |
Employee's myHotelTeam Activation Status. |
modifiedon |
Last date the employee was modified on. |
Additional Configurable Fields
The following fields will only display if they are configured at your hotel within the Employee Manager:
- Address1
- Address2
- City
- State
- Zip
- Country
- FirstDayofWork
- Birthday
- EmployeeNotes
- SourceofHire
- Race
- Gender
- MaritalStatus
- EducationLevel
- PrimaryTelephone
- SchedulePreferenceNotes
- PrimaryEmail
- TermReason
- LastReviewDate
- FullTimeIndicator
Limits
- Security Restrictions: If your hotel collects social security numbers, they will never download using the GetEmployees API as a security measure.
Comments
0 comments
Article is closed for comments.