GetAppointmentsByDate()

Description

Returns appointment details for the specified employee(s) and date range.

GetAppointmentsByDate(XmlIds AS String, StartDate AS Date, EndDate AS Date)

Return Value

XML String

Parameters

XmlIds = XML String containing the Employee Ids of the records to return. You must format this string using the XML IdList Structure Definition.
StartDate = Start date for the records to return.
EndDate = End date for the records to return.

Remarks

XML String has the following structure:

Field	Type	Length	Description
iId	Integer	4	Primary Key - Unique Identifier
iLocationId	Integer	4	Not used.
iApptId	Integer	4	Appointment Header Id.
dDate	DateTime	8	Appointment Date.
cTimeOfDay	String	4	Time of appointment, in military (HHMM) format.
iStandId	Integer	4	Standing Appointment Header Id. Foreign key to Standing Header iId.
iEmpId	Integer	4	Employee Id. Foreign key to Employee iId.
iClientId	Integer	4	Client Id. Foreign key to Clients iId.
iServId	Integer	4	Service Id. Foreign key to Services iId.
nStartLen	Decimal	7,4	Start length for appointment.
nGapLen	Decimal	7,4	Gap length for appointment.
nFinishLen	Decimal	7,4	Finish length for appointment.
iApptType	Integer	4	Appointment Type Id. Foreign key to Appointment Types iId.
lCheckedIn	Boolean	1	Indicates whether the client has checked in for this service.
cCheckInTime	String	4	Appointment check in time, in military (HHMM) format.
cCheckOutTime	String	4	Appointment check out time, in military (HHMM) format.
iResourceId	Integer	4	Resource Id. Foreign key to Resource Header iId.
iGenderId	Integer	4	Indicates the gender preference for the service provider. 0 = No preference 1 = Male 2 = Female
nLineNo	Integer	4	Line item number.
lNoShow	Boolean	1	Indicates whether the appointment was marked as a "No Show".
iBlockId	Integer	4	Not used.
iStatusId	Integer	4	Not used.
iGId	Integer	4	Appointment Record Global Id.
lLate	Boolean	1	Indicates whether the appointment was marked as "Running Late".
iPayClId	Integer	4	Paying Client Id. Foreign key to Clients iId.
mAppNotes	String		Appointment notes.
tOrigDateTime	DateTime	8	Date/time booked.
tLastChg	DateTime	8	Date/time last updated.
iOrigLogin	Integer	4	Login Id of employee that originally booked the appointment.
iLastLogin	Integer	4	Login Id of employee that last changed the appointment.
lPreBook	Boolean	1	Indicates whether the appointment was pre-booked.
lBookedOnline	Boolean	1	Indicates whether the appointment was booked online.
iSeconds	Integer	4	Total number of seconds taken to book appointment.
iClass	Boolean	1	Indicates whether the appointment record belongs to a class.
lPost	Boolean	1	Indicates whether Millennium posted the appointment details to a property management system. (Property Management System interface users only)
tArrived	DateTime	8	Date/time the client arrived for appointment.
iConfirmedBy	Integer	4	Login Id of the employee who confirmed the appointment.
tConfirmed	DateTime	8	Date/time the client received a confirmation for the appointment.
cConfirmation	String	10	Appointment confirmation code.
cClient	String	50	Client name.
cService	String	50	Service name.
cEmpName	String	50	Employee name.
cResourceDescr	String	50	Description of the resource booked for the appointment.
cBlockDescr	String	50	Block description.
cGenderDescr	String	50	Gender description.
cApptTypeDescr	String	50	Appointment type description.