Skip to main content

Book an appointment

POST 
/calendar-backend/public/api/v1/branches/:branchPublicId/services/:servicePublicId/dates/:date/times/:time/book

Book an appointment.

Book an appointment for the specified branch and service at the given date and time.

Title, Note and Customer data is provided in the booking information POST BODY in JSON format. The BookingInformationDTO object wraps an optional title, notes and a nested Customer object. Typically, one would either supply a fully populated Customer object for a new customer, a Customer with a populated publicId for an already identified customer or using the setting-defined 'mapping field' (externalId, customerNumber).

Example:

curl -X POST -H 'Content-Type: application/json'
     -d '{
     "title":"Meeting",
     "notes":"",
     "customer":{
         "firstName":"Charles",
         "lastName":"Ryder",
         "email":"charles.ryder@brideshed.org",
         "phone":"+4411111111",
         "dateOfBirth":"1904-07-11",
         "addressLine1":"38 Great James Street",
         "addressZip":"WC1",
         "addressCity":"London",
         "addressCountry":"UK"
     }
 }'
 http://localhost:8080/calendar-backend/public/api/v1/branches/aab504e1427abd602e1b9c0805284a923bd832d9f043d6e91fa2e3c855985538/services/0947a7e6f3227769a0b5b4d5ce895072753e10da2bb132b7ea9e79afa412f315/dates/2017-02-13/times/16:25/book

Request​

Responses​

A Json object of com.qmatic.qp.calendar.rest.dto.AppointmentDTO