Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
BookingService
  • /bookings
  • /bookings/{reference}
  • POST
  • DELETE GET
Appointment booking service.
LocationService
  • /locations
  • /locations/{id}
  • /locations/{id}/schedules
  • GET
  • GET
  • GET
Practice location query service.
ScheduleService
  • /schedules/{id}
  • /schedules/{id}/appointmentTypes
  • /schedules/{id}/busy
  • /schedules/{id}/free
  • /schedules/{id}/freebusy
  • GET
  • GET
  • GET
  • GET
  • GET
Service for querying appointment schedules.

Data Types

JSON

type description
AppointmentType Appointment type.
Booking Appointment booking request.
FreeBusy Schedule free and busy time ranges.
Location Practice location.
Range Date/time range.
Resource Booking resource.
Schedule Appointment schedule.