Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

The flow of rescheduling appointments with several services is the same as the flow of rescheduling with a single service. The main interactions are:

  • Get the list of booked appointments for the specific customer (including bookings with several services)

  • Get booked appointments with multiple services

  • Get timeslots for several services selected

  • Reserve a timeslot for multiple services

  • Reschedule appointment with a new reservation ID.

API endpoints

Search for appointment

If the service combinations feature is turned on the following endpoint should be used to search for the specific customer’s appointment by personal identifier, where the personal identifier allows to retrieve all appointments related to the specific customer.

GET/external/v1/serviceCombination/appointments/search

Attributes

Name

Type

Required

Description

Accept-Language

string

yes

Requested language for service names. The system will support languages depending on Tenant Localization settings (possible values are: en_US, en_UK, fr_FR, nl_NL, de_DE, it_IT, ES_es )

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.

Request Body

{
  "customer": {
    "personalIdentifier": "5B0I96O2xqD8XpyOdP7yQQhBIueKzaQZSfdDYx32mL8v1"
  }
}

Response Schema

{
  "appointmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "timeSlot": {
    "startTime": "2022-03-03T09:00:00+01:00",
    "endTime": "2022-03-03T09:00:00+01:00"
  },
  "customer": {
    "firstName": " ylH.'L'bIpyn.C'ycs-Ia}eygcbls{.}H '",
    "lastName": "w.w-}tg-Dyncr}H wni",
    "phoneNumber": "i  p}Dii+{g t{}{{gig}  +-}}}{ }{}p}ti",
    "email": "string",
    "dateOfBirth": "2000-01-01"
  },
  "service": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "config": {
      "maxNumberOfReservations": 0
    }
  },
  "branch": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "address": {
      "streetName": "string",
      "zipCode": "string",
      "city": "string",
      "country": "string"
    },
    "location": {
      "longitude": 180,
      "latitude": 180
    }
  },
  "numberOfReservations": 0,
  "supportNotes": "string"
}

Get Appointment details

Allows to get all details for the specific appointment

GET/external/v1/serviceCombination/appointments/{appointmentId}

Attributes

Name

Type

Required

Description

Accept-Language

string

yes

Requested language for service names. The system will support languages depending on Tenant Localization settings (possible values are: en_US, en_UK, fr_FR, nl_NL, de_DE, it_IT, ES_es )

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.

AppointmentID

string

yes

Appointment ID (GUID)

Response schema

Code 200 - OK

{
  "appointmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "timeSlot": {
    "startTime": "2022-03-03T09:00:00+01:00",
    "endTime": "2022-03-03T09:00:00+01:00"
  },
  "customer": {
    "firstName": "eraCnbwe.ce swt'IHrILrcyHI}{ilL.H bDLLc-{bne aHHbCwtlaipHsyas.I}bH'w'egriaattHb Ic{D rns",
    "lastName": "rccsgywspts.CDnsCyeb'wLb{pnwb gDIsCyLieelnl.gipw-{--bL b yl{",
    "phoneNumber": "p ",
    "email": "string",
    "dateOfBirth": "2000-01-01"
  },
  "service": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "config": {
      "maxNumberOfReservations": 0
    }
  },
  "branch": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "address": {
      "streetName": "string",
      "zipCode": "string",
      "city": "string",
      "country": "string"
    },
    "location": {
      "longitude": 180,
      "latitude": 180
    }
  },
  "numberOfReservations": 0,
  "supportNotes": "string"
}

Reschedule an appointment

PUT/external/v1/serviceCombination/appointments/{appointmentId}/reschedule

{
  "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Attributes

Name

Type

Required

Description

1

Accept-Language

string

yes

Requested language for service names, The system will support languages depending on Tenant Localization settings (possible values are: en_US, en_UK, fr_FR, nl_NL, de_DE, it_IT, ES_es )

2

X-TENANT-ID

string

yes

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

3

AppointmentID

string

yes

Appointment ID (GUID) for reschelduling

Request Body

{
  "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

where ReservationID is a new reservation that was created to change/reschedule the existing appointment.

Response Body

{
  "appointmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "timeSlot": {
    "startTime": "2022-03-03T09:00:00+01:00",
    "endTime": "2022-03-03T09:00:00+01:00"
  },
  "customer": {
    "firstName": "D-cD-",
    "lastName": "byw'Hiai",
    "phoneNumber": "}g} }-t+}gpD+gt}gtDgg+D+ -{",
    "email": "string",
    "dateOfBirth": "2000-01-01"
  },
  "service": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "config": {
      "maxNumberOfReservations": 0
    }
  },
  "branch": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "address": {
      "streetName": "string",
      "zipCode": "string",
      "city": "string",
      "country": "string"
    },
    "location": {
      "longitude": 180,
      "latitude": 180
    }
  },
  "numberOfReservations": 0,
  "supportNotes": "string"
}

  • No labels