Skip to main content

Get all appointments matching the specified parameter values

GET 
/calendar-backend/api/v1/appointments
  • Get all appointments matching the specified parameter values

Allowed parameters:

  • start: the earliest start date. Full or partial datetime string, e.g. "2021" or "2021-07-28" or "2021-07-28T06:40:00"

  • end: The latest end date. Full or partial datetime string, e.g. "2021" or "2021-07-28" or "2021-07-28T06:40:00"

  • resource: One or multiple resource id's, as a single value, a list or a list of lists. E.g. "1" or "1,2,3" or "[1,2,3],[5,27]". The "null" value is allowed if it is the only value, i.e. not part of a list: "resource=null".

  • limit: The maximum number of returned results. E.g. "100".

  • offset: The offset of returned results. E.g "5".

  • branch: One or multiple branch id's, as a single value, a list or a list of lists. E.g. "1" or "1,2,3" or "[1,2,3],[5,27]". The "null" value is allowed if it is the only value, i.e. not part of a list: "branch=null".

  • timeZoneBranchId: The id of the branch from which to get a timeZone to apply to the start and end times. E.g. "2".

Examples of usage:

curl -u user:password -i -X GET http://localhost:8080/calendar-backend/api/v1/appointments?start=2014-10-30&end=2014-11-06&resource=1
curl -u user:password -i -X GET http://localhost:8080/calendar-backend/api/v1/appointments?resource=[1,2,3]
curl -u user:password -i -X GET http://localhost:8080/calendar-backend/api/v1/appointments?resource=1&offset=3&limit=10
curl -u user:password -i -X GET http://localhost:8080/calendar-backend/api/v1/appointments?start=2022-01-31&end=2022-02-07&timeZoneBranchId=1&branch=null&resource=null

Responses​

A list of com.qmatic.qp.calendar.rest.dto.AppointmentDTO