Show/Hide Toolbars

AppointmentRepository Requests Summary

Request

Description

insertAppointment

Saves a new appointment to the repository.

updateAppointment

Updates a previously saved appointment.

readAppointment

Retrieves a appointment from the repository based on a unique key. For a list of available properties, see the type class, appointment.

readAppointmentsByCriteria

Retrieves a set of appointments based on specified criteria. If the criteria is empty, then the search will be for all appointments. The specified limit takes precedence over the current system setting for the maximum number of search results to obtain. For a list of available properties, see the type class, appointment.

deleteAppointment

Deletes the appointment specified by the unique key.

readRecentlyViewedAppointments

Read and return recently reviewed appointments.

AppointmentRepository Data Objects Summary

Data Object

Description

1 appointment

2 appointmentCreate

3 appointmentUpdate

1 Appointment record property container returned when you read or search appointments. When defining a repository search's return properties, refer to the property names defined in this object.

2 Appointment record property container used to set a new appointment's properties. This object is passed as a request parameter when you create (insert) an appointment.

3 Appointment record property container used to update or clear an appointment's properties. This object is passed as a request parameter when you update an appointment.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TAppointment object.

1 appointmentResource

2 appointmentResourceCreate

3 appointmentResourceUpdate

1 Appointment resource object property container returned when you read or search appointment resources.

2 Appointment resource object property container used to set a new appointment resource's properties.

3 Appointment resource object property container used to update or clear an appointment resource's properties.

appointmentResourceType

Subclass of lookupItem. Use the provided get methods to read an appointment resource's associated type.

lookupItem

Abstract class that provides get methods to read properties associated with TeamConnect system lookup table items.

 

1 attendee

2 attendeeCreate

3 attendeeUpdate

1 Attendee object property container returned when you read or search attendees.

2 Attendee object property container used to set a new attendee's properties.

3 Attendee object property container used to update or clear an attendee's properties.

attendanceType

An enumeration used to indicate an attendee's plans to attend an appointment.

Options include:

WILL_ATTEND

TENTATIVE

WILL_NOT_ATTEND

UNKNOWN