GetAppointment()

Description

Returns an appointment object you can use to update that appointment and appointment details.

GetAppointment(AppointmentId AS Number)

Return Value

Object

Parameters

AppointmentId = Id of the appointment to return.

Remarks

Object has the following structure:

Field	Type	Length	Description
iId	Integer	4	Primary Key - Unique Identifier.
dDateDeleted	DateTime	8	Date deleted.
iGlobalId	Integer	4	Appointment Global Id.
eObjectState	Enumeration	1	Indicates the status of the object. -1 = Unchanged 0 = New/Added 1 = Changed 2 = Deleted
cStartTime	String	4	Start time of appointment, in military (HHMM) format.
iStandingHeaderId	Integer	4	Standing Appointment Header Id. Foreign key to Standing Header iId.
iEmployeeId	Integer	4	Employee Id. Foreign key to Employee iId.
iClientId	Integer	4	Client Id. Foreign key to Clients iId.
iServiceId	Integer	4	Service Id. Foreign key to Services iId.
nStartLength	Decimal	7,4	Start length for appointment.
nGapLength	Decimal	7,4	Gap length for appointment.
nFinishLength	Decimal	7,4	Finish length for appointment.
iAppointmentType	Integer	4	Appointment Type Id. Foreign key to Appointment Types iId.
lHasCheckedIn	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
lIsNoShow	Boolean	1	Indicates whether the appointment was marked as a "No Show".
lIsRunningLate	Boolean	1	Indicates whether the appointment was marked as Running Late.
iPayingClientId	Integer	4	Paying Client Id. Foreign key to Clients iId.
cNotes	String		Appointment notes.
dAppointmentDate	DateTime	8	Appointment date.
dBookedOn	DateTime	8	Date/time booked.
dLastChanged	DateTime	8	Date/time last updated.
iBookedByLoginId	Integer	4	Login Id of employee that originally booked the appointment.
iLastChangedByLoginId	Integer	4	Login Id of employee that last changed the appointment.
lPreBook	Boolean	1	Indicates whether the client pre-booked the appointment.
lBookedOnline	Boolean	1	Indicates whether the client booked the appointment using Online Booking.
iTotalTimeToBook	Integer	4	Total number of seconds taken to book appointment.
lIsClass	Boolean	1	Indicates whether the appointment record belongs to a class.
lChargeApptToRoom	Boolean	1	Indicates whether Millennium posted the appointment details to a property management system. (Property Management System interface users only)
cConfirmationTypes	String	10	Appointment confirmation code.