Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Retrieve the list of available service combinations (combinable, uncombinable, combined) for the specific branch ID

  • Get time slots for the combined services and branch ID

  • Reserve a time slot for the appointment with more than 1 service included

  • Confirm a booking with multiple services

API endpoints

Get Service Combinations

GET /external/v1/serviceCombination/branch

...

Code Block
[
  {
    "branchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serviceCombinations": [
      {
        "resourceTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "combinableServices": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "unCombinableServices": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "combinedServices": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ]
      }
    ]
  }
]

Get Service combinations

...

for Branch ID

Allows to retrieve the list of combinable, uncombinable and combined services for the specific Branch.

...

"combinedServices" the service IDs that are marked as “combinable“ in Configurations, so can be combined within one appointment.

Get Timeslots for several services selected

GET /external/v1/serviceCombination/branch/{serviceId}/timeslots

...

Name

Type

Required

Description

Service IDs

strings

yes

The service ID to get the list of timeslots. Several “combined” service IDs can be specified

Branch ID

string

yes

The Branch id, ex. "3fa85f64-5717-4562-b3fc-2c963f66afa6"

requestedResourceID

string

no

The resource ID for the services selected

numberofReservations

integer

no

The total number of reservations (people, times) for all services included in the appointment selected (for instance, if the number for service 1 is 1 but for service 2 is specified as 2 then the value that should be specified is 3)

The default value is 1.

X-TENANT-ID

string

yes

The tenant id to use for this operation. The tenant id must be the same as an existing system Id.

...

Code Block
{
  "serviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "branchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "timeSlots": [
    {
      "startTime": "2022-03-03T09:00:00+01:00",
      "endTime": "2022-03-03T09:00:00+01:00"
    }
  ]
}

Create

...

a new Reservation with multiple services

POST /external/v1/serviceCombination/reservations

...

Code Block
{
  "appointmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "serviceWithNrOfReservationsValues": [
    {
      "serviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "nrOfReservations": 0
    }
  ],
  "branchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "requestedResource": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "timeSlot": {
    "startTime": "2022-03-03T09:00:00+01:00",
    "endTime": "2022-03-03T09:00:00+01:00"
  },
  "expiration": "2024-07-05T16:08:17.748Z",
  "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Confirm an Appointment with multiple services

PUT /external/v1/serviceCombination/reservations/{reservationId}

...