v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Appointment

Check in an appointment

Check in the selected appointment

post/api/business/{businessId}/branch/{branchId}/appointment/{appointmentId}/checkin

Path parameters

businessIdstring required
branchIdstring required
appointmentIdstring required

Response

Appointment checked in successfully

Example response

{
  "_embedded": {
    "appointments": [
      {
        "appointmentId": "ab123",
        "version": 1,
        "appointmentDate": "2018-01-01",
        "startTime": "09:00:00",
        "endTime": "09:30:00",
        "price": 40,
        "staffId": "staffid",
        "roomId": "roomid",
        "machineId": "machineid",
        "confirmed": true,
        "serviceId": "serviceid",
        "staffRequest": true,
        "preferredStaff": true,
        "clientId": "clientid",
        "serviceRewardId": "servicerewardid",
        "courseId": "courseId",
        "courseName": "courseName",
        "clientCourseId": "clientCourseId",
        "clientCourseItemId": "clientcourseitemid",
        "purchasingBranchId": "purchasingBranchId",
        "serviceGroupItemOptionId": "servicegroupitemoptionid",
        "serviceGroupId": "servicegroupid",
        "parentServiceGroupId": "parentservicegroupid",
        "serviceName": "serviceName",
        "state": "BOOKED",
        "activationState": "ACTIVE",
        "depositAmount": 20,
        "bookingId": "bookingid",
        "source": "source",
        "groupBookingId": "groupbookingid",
        "deleted": true,
        "notes": "This is a note about the appointment",
        "internetServiceCategories": [
          {
            "id": "ab123",
            "name": "Cut & Style"
          }
        ],
        "branchId": "X9QpRsZ3bSvhJAaakg9TXQ"
      }
    ]
  }
}