Returns detailed information for the specified employee(s), grouped by employee classification.
GetEmployeeByClass(XmlIds AS String, IncludeDeleted AS Boolean, IncludeInactive AS Boolean)
XML String
XmlIds = XML String containing the Classification Ids of the records to return. You must format this string using the XML IdList Structure Definition.
IncludeDeleted = Select to include deleted records in the results.
IncludeInactive = Select to include inactive records in the results.
XML String has the following structure:
|
Field |
Type |
Length |
Description |
|
iId |
Integer |
4 |
Primary Key - Unique Identifier. |
|
iLocationId |
Integer |
4 |
Not used. |
|
cLastName |
String |
20 |
Client last name. |
|
cFirstName |
String |
15 |
Client first name. |
|
cAddress1 |
String |
40 |
Address (Line 1). |
|
cAddress2 |
String |
40 |
Address (Line 2). |
|
cCity |
String |
25 |
City. |
|
cState |
String |
3 |
State. |
|
cZip |
String |
10 |
Zip code. |
|
cCode |
String |
10 |
Identifying code for the employee. |
|
lAllowAppts |
Boolean |
1 |
Indicates whether the employee appears in the Appointment Book. |
|
cSocial |
String |
9 |
Employee social security number. |
|
lMarried |
Boolean |
1 |
Indicates whether the employee is married. |
|
nSex |
Decimal |
1,0 |
Employee gender. 1 = Male 2 = Female |
|
nAge |
Decimal |
1,0 |
Employee age. |
|
dBirthday |
DateTime |
8 |
Employee date of birth. |
|
dAnnivDay |
DateTime |
8 |
Employee anniversary date. |
|
cEmail |
String |
40 |
Employee email address. |
|
cArea |
String |
4 |
Employee home area code. |
|
cPhone |
String |
8 |
Employee home phone. |
|
cCellArea |
String |
4 |
Employee cell area code. |
|
cCellPhone |
String |
8 |
Employee cell phone. |
|
cAutopage |
String |
10 |
Employee auto-page number. |
|
dStartDate |
DateTime |
8 |
Start date. |
|
dTermDate |
DateTime |
8 |
Termination date. |
|
gPicture |
|
|
Not used. |
|
cNotes |
String |
|
Employee notes. |
|
nLevel |
Decimal |
1,0 |
Service level. |
|
dPictureDate |
DateTime |
8 |
Upload date for the employee's picture. |
|
cEmgContact |
String |
30 |
Emergency contact name. |
|
cEmgArea |
String |
3 |
Emergency contact area code. |
|
cEmgPhone |
String |
7 |
Emergency contact phone. |
|
lInactive |
Boolean |
1 |
Indicates whether the employee is inactive. |
|
dDateDel |
DateTime |
8 |
Date deleted. |
|
lShowTips |
Boolean |
1 |
Indicates whether the employee displays on the Tips window in Millennium. |
|
lShowSched |
Boolean |
1 |
Indicates whether the employee displays on the Employee Schedules window in Millennium. |
|
lPunchIn |
Boolean |
1 |
Indicates whether the employee must punch-in. |
|
nSequence |
Decimal |
5,0 |
Order in which employees appear in the Appointment Book. |
|
nBakColor |
Integer |
4 |
The background color for the header of the employee column in the Appointment Book. |
|
nForeColor |
Integer |
4 |
The text color for the header of the employee column in the Appointment Book. |
|
nApptMask |
Decimal |
1,0 |
|
|
iResourceId |
Integer |
4 |
Employee Default Resource iId. Foreign key to resource iId. |
|
lBookOnline |
Boolean |
1 |
Indicates whether appointments can be booked online for this employee. |
|
lLimitHours |
Boolean |
1 |
Indicates whether the hours are limited. |
|
lSun |
Boolean |
1 |
Indicates whether you can book appointments online on Sunday with this employee. Only used when lLimitHours is TRUE. |
|
cSunStart |
String |
4 |
Start time of when appointments can be booked online on Sunday. |
|
cSunEnd |
String |
4 |
End time of when appointments can be booked online on Sunday. |
|
lMon |
Boolean |
1 |
Indicates whether you can book appointments online on Monday with this employee. Only used when lLimitHours is TRUE. |
|
cMonStart |
String |
4 |
Start time of when appointments can be booked online on Monday. |
|
cMonEnd |
String |
4 |
End time of when appointments can be booked online on Monday. |
|
lTue |
Boolean |
1 |
Indicates whether you can book appointments online on Tuesday with this employee. Only used when lLimitHours is TRUE. |
|
cTueStart |
String |
4 |
Start time of when appointments can be booked online on Tuesday. |
|
cTueEnd |
String |
4 |
End time of when appointments can be booked online on Tuesday. |
|
lWed |
Boolean |
1 |
Indicates whether you can book appointments online on Wednesday with this employee. Only used when lLimitHours is TRUE. |
|
cWedStart |
String |
4 |
Start time of when appointments can be booked online on Wednesday. |
|
cWedEnd |
String |
4 |
End time of when appointments can be booked online on Wednesday. |
|
lThu |
Boolean |
1 |
Indicates whether you can book appointments online on Thursday with this employee. Only used when lLimitHours is TRUE. |
|
cThuStart |
String |
4 |
Start time of when appointments can be booked online on Thursday. |
|
cThuEnd |
String |
4 |
End time of when appointments can be booked online on Thursday. |
|
lFri |
Boolean |
1 |
Indicates whether you can book appointments online on Friday with this employee. Only used when lLimitHours is TRUE. |
|
cFriStart |
String |
4 |
Start time of when appointments can be booked online on Friday. |
|
cFriEnd |
String |
4 |
End time of when appointments can be booked online on Friday. |
|
lSat |
Boolean |
1 |
Indicates whether you can book appointments online on Saturday with this employee. Only used when lLimitHours is TRUE. |
|
cSatStart |
String |
4 |
Start time of when appointments can be booked online on Saturday. |
|
cSatEnd |
String |
4 |
End time of when appointments can be booked online on Saturday. |
|
lLimitServs |
Boolean |
1 |
Indicates if only a limited number of services can be booked online for this employee. |
|
lIgnorePre |
Boolean |
1 |
If TRUE, the employee's clients do not receive pre-book discounts. |
|
lIgnoreOnline |
Boolean |
1 |
If TRUE, the employee’s clients do not receive discounts for booking online. |
|
iGId |
Integer |
4 |
Employee Global Id. |
|
cMaskText |
String |
20 |
Masking text displayed on the Appointment Book. |
|
nMaskLen |
Decimal |
6,3 |
Length of the mask on then Appointment Book. |
|
iResourceId2 |
Integer |
4 |
Second Employee Default Resource iId. Foreign Key to Resource iId. |
|
lMaskBookable |
Boolean |
1 |
Indicates whether the masking represents a non-bookable time. TRUE = Masking represents a bookable time FALSE = Masking represents a non-bookable time. |
|
cNetEmpName |
String |
40 |
Name to display in Online Booking. |
|
lUseInProductivity |
Boolean |
1 |
Indicates whether the employee is included in productivity calculations. |
|
tChanged |
DateTime |
8 |
Date last changed. |
|
iChgBy |
integer |
4 |
Id of the employee who last changed the employee record. |
|
cEmpNumber |
String |
40 |
Employee number. |
|
lAllowDblBook |
Boolean |
1 |
Indicates whether you can double-book appointments with the employee. |
|
iCellCarrier |
Integer |
4 |
Id of the employee's cell phone carrier. |
|
lShowReg |
Boolean |
1 |
Indicates whether the employee is available for selection on the Register screen. |
|
lShowRegOther |
Boolean |
1 |
Indicates whether the employee is available for selection on windows accessible from the Register screen. |