Sign in

v1

latestSwagger 2.02026-07-14433261.5 KB
DiaryController

Get a specific diary appointment given its unique Object ID (OID)

get/v2/tier1/{shortName}/diary/appointments/{diaryAppointmentID}

Path parameters

shortNamestring required

The unique client short-name

diaryAppointmentIDstring required

The unique ID of the DiaryAppointment

Response

OK

AppointmentTypestring

The diary appointment type.

Cancelledboolean

Whether the appointment has been cancelled.

Commentstring

The appointment comments text.

CreatedAtstring date-time

The date/time this appointment was created.

CreatedBystring

The staff member that created this appointment.

ETagstring

A unique identifier defining the object and change revision.

Endstring date-time

The end date/time of this appointment.

OIDstring

The unique Object ID (OID).

RemindAtstring date-time

The date/time to remind the staff member of this appointment.

RemindBefore'Min' | 'Min2' | 'Min5' | 'Min10' | 'Min15' | 'Min30' | 'Min45' | 'Hour' | 'Hour2' | 'Hour3' | 'Hour6' | 'Hour12' | 'Day' | 'Day2' | 'Day3' | 'Week' | 'NoReminder'

The number of minutes before the appointment start date/time to remind the staff member. -1 means don't remind.

Staffstring

The staff member holding this appointment.

Startstring date-time

The start date/time of this appointment.

Subjectstring

The appointment subject text.