Version 1.10.1

POST /api/business/{businessId}/branch/{branchId}/booking/{bookingId}/cancel

Cancel a booking

Return Type:

Changed response : 200 OK

Booking cancelled successfully

Changed response : 404 Not Found

Business, branch or booking with the specified ids don't exist

POST /api/business/{businessId}/branch/{branchId}/booking/{bookingId}/appendnote

Create a note for the booking

Request:

Changed content type : application/json

Return Type:

Changed response : 200 OK

Note created successfully

Changed response : 400 Bad Request

Booking note data is invalid, unable to create a booking note

Changed response : 500 Internal Server Error

An error occurred while trying to create a note

Changed response : 404 Not Found

Business, branch or booking with the specified ids don't exist

POST /api/business/{businessId}/branch/{branchId}/booking/{bookingId}/activate

Activate a booking

Request:

Changed content type : application/json

Return Type:

Changed response : 200 OK

Booking activated successfully

Changed response : 400 Bad Request

Booking data is invalid, unable to activate a booking

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

POST /api/business/{businessId}/branch/{branchId}/appointment/cancel

Cancel appointments

Return Type:

Changed response : 200 OK

Appointments cancelled successfully

Changed response : 404 Not Found

Business, branch or appointment with given ids don't exist

PUT /api/business/{businessId}/clientcourse/{clientCourseId}

Return Type:

Changed response : 404 Not Found

Client Course with a given id doesn't exist

GET /api/business/{businessId}/client/{clientId}

Retrieve a client

Return Type:

Changed response : 404 Not Found

Business or client with the specified ids don't exist

Changed response : 200 OK

Specified client retrieved

PUT /api/business/{businessId}/client/{clientId}

Update a client

Return Type:

New response : 200 OK

Client updated successfully

Deleted response : 202 Accepted

Accepted

Changed response : 400 Bad Request

Client data is invalid, unable to update a client

• New content type : application/json

• Deleted content type : */*

Changed response : 404 Not Found

Business or client with the specified ids don't exist

POST /api/business/{businessId}/branch/{branchId}/booking

Create a booking

Parameters:

Changed: force_selected_time in query

force a booking to be created at the selected time

Return Type:

Changed response : 400 Bad Request

Booking data is invalid, unable to create a booking

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 201 Created

Booking created successfully

POST /api/business/{businessId}/branch/{branchId}/appointment/{appointmentId}/note

Return Type:

Changed response : 404 Not Found

Appointment with specified id doesn't exist

Changed response : 200 OK

Appointment note updated successfully

GET /api/business/{businessId}/branch

List branches

Return Type:

Changed response : 404 Not Found

Business with the specified id doesn't exist

Changed response : 200 OK

Branches listed

GET /api/business/{businessId}/branch/{branchId}/room

List rooms

Parameters:

Changed: size in query

number of rooms to return, max is 100

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Rooms listed

GET /api/business/{businessId}/branch/{branchId}/room/{roomId}

Retrieve a room

Return Type:

Changed response : 404 Not Found

Business, branch or room with the specified ids don't exist

Changed response : 200 OK

Specified room retrieved

GET /api/business/{businessId}/branch/{branchId}/machine

Get a list of machines for the specified business id and branch id. List can be filtered by DateTime of update with a possibility to include archived machines

Parameters:

Changed: size in query

number of machines to return, max is 100

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Machines listed

GET /api/business/{businessId}/branch/{branchId}/machine/{machineId}

Get a machine for the specified business id, branch id and machine id

Return Type:

Changed response : 404 Not Found

Business, branch or machine with the specified ids don't exist

Changed response : 200 OK

Specified machine retrieved

POST /api/business/{businessId}/client

Create a client

Return Type:

Changed response : 400 Bad Request

Client data is invalid, unable to create a client

• New content type : application/json

• Deleted content type : */*

Changed response : 404 Not Found

Business with the specified id doesn't exist

Changed response : 201 Created

Client created successfully

GET /api/business/{businessId}/client

List clients

Parameters:

Changed: firstName in query

client first name to filter by. To search by exact match use John. To query by matching first letters use ~Jo% which will find both John and Joe

Changed: lastName in query

client last name to filter by. To search by exact match use Doe. To query by matching first letters use ~Do% which will find both Doe and Doran

Return Type:

Changed response : 404 Not Found

Business with the specified id doesn't exist

Changed response : 200 OK

Clients listed

GET /api/business/{businessId}/client/{clientId}/service-history

Retrieve client's service histories

Return Type:

Changed response : 404 Not Found

Business or client with the specified ids don't exist

Changed response : 200 OK

Client's service histories listed

GET /api/business/{businessId}/client-batch

Retrieve a batch of clients

Return Type:

Changed response : 404 Not Found

Business with the specified id doesn't exist

Changed response : 200 OK

Batch of clients retrieved

DELETE /api/business/{businessId}/branch/{branchId}/break/{breakId}

Delete a break

Return Type:

Changed response : 204 No Content

Break deleted successfully

Changed response : 404 Not Found

Business, branch or break with the specified ids don't exist

GET /api/business/{businessId}/branch/{branchId}/break/{breakId}

Retrieve a break

Return Type:

Changed response : 404 Not Found

Business, branch or break with the specified ids don't exist

Changed response : 200 OK

Specified break retrieved

PUT /api/business/{businessId}/branch/{branchId}/break/{breakId}

Update a break

Return Type:

Changed response : 404 Not Found

Business, branch or break with the specified ids don't exist

Changed response : 409 Conflict

Break has been updated since it was read

Changed response : 200 OK

Break updated successfully

PUT /api/business/{businessId}/branch/{branchId}/appointment/{appointmentId}

Parameters:

Changed: force_selected_time in query

force an appointment to be moved at selected time

Return Type:

Changed response : 400 Bad Request

Appointment data is invalid, unable to update an appointment

Changed response : 409 Conflict

Appointment has been updated since it was read

Changed response : 404 Not Found

Appointment with the specified id doesn't exist

Changed response : 200 OK

Appointment updated successfully

POST /api/business/{businessId}/branch/{branchId}/break

Create a break

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 201 Created

Break created successfully

GET /api/business/{businessId}/branch/{branchId}/break

List breaks

Parameters:

Changed: size in query

number of breaks to return, max is 100

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Breaks listed

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

Return Type:

Changed response : 404 Not Found

Business, branch or appointment with given ids don't exist

Changed response : 200 OK

Appointment checked in successfully

POST /api/business/{businessId}/branch/{branchId}/appointment/confirm

Return Type:

Changed response : 404 Not Found

Business or branch with given ids don't exist

Changed response : 200 OK

Appointments confirmed successfully

GET /api/business/{businessId}/branch/{branchId}/appointment

List appointments

Parameters:

Changed: size in query

number of appointments to return, max is 100

Return Type:

Changed response : 404 Not Found

Business or branch with specified ids don't exist

Changed response : 200 OK

Appointments listed