POST

Bookings v2

PostBookings

PostBookingOutOfSlot

Creates a new booking. Any startDateTime and endDateTime are allowed. If serviceProviderId is specified, the booking status will be Accepted (2), otherwise the status will be Pending (1) and will require approval by an admin.

Reschedule

Approves a booking and allocates a service provider to it. The booking must have Pending (1) status and the service provider (serviceProviderId) must be available for this booking timeslot otherwise the request will fail.

AcceptBooking

Approves a booking and allocates a service provider to it. The booking must have Pending (1) status and the service provider (serviceProviderId) must be available for this booking timeslot otherwise the request will fail.

CancelBooking

Cancels a booking. Only future bookings that have Pending (1) or Accepted (2) status can be cancelled.

RejectBooking

Reject a booking request. Only Pending (1) bookings that can be rejected.

ChangeUser

Updates the booking user with the current user. It requires a Booking UUID

ValidateOnHoldBooking

Validates an on hold booking. (1) For booking without payment: It will add additional booking information to an existing booking and change the status of the booking (2) For booking with payment: It will add additional booking information to an existing booking and extend on hold expiry, but will NOT change the status of booking

Services v2

CreateService

Creates a service for booking.

CreateTimeslotItem

Creates a new weekly recurring timeslot for a service.

Service Notification Template v2

CreateEmailNotificationTemplate

Creates a single email notification template of a service.

Encryption (As of version 2)

Encrypt

Encrypt the query parameters for making a booking via standalone flow. For encrypting dynamic values, serviceId should be provided. If a service is not selected yet, serviceGroupId and dynamic values for each service under the service group should be provided.

Decrypt

Decrypt the body

Service Providers (As of version 3)

AddServiceProviders

Creates multiple service providers (json format).

AddServiceProvidersText

Creates multiple service providers (CSV format). The csv content must contain a single header called name. Optional csv content: email, phone, autoAcceptBookings, description, aliasName, locationName, locationAddress, paymentAmount

CreateTimeslotItem

Creates a new weekly recurring timeslot for a service provider.

DeleteSPs

Bulk delete service providers. If service provider has any ongoing or upcoming event, API will return failed for this particular service provider. If service provider has any upcoming booking [Accepted | PendingAcceptance | PendingApproval], API will return failed for this particular service provider. All upcoming normal bookings with status OnHold, it will mark expired All records of other table that associate with service provider will be soft deleted Record of service_provider_group_map and admin_user will be hard deleted If service provider has mol user (agencyUserId), it will be hard deleted from AWS Cognito.

CreateProviderScheduleForms

CreateTimeslotItemForServiceProviderScheduleForm

Users (As of version 2)

AdminCognitoLogin

Log user into Cognito User Pool

VerifyOTPChallenge

Verify Cognito OTP challenge

NewPasswordRequiredChallenge

Force user to reset password when they log in to Cognito for the first time

NewPasswordRequiredChallenge

Force user to reset password when they log in to Cognito for the first time

Unavailabilities v2

AddUnavailability

Creates an unavailable (blocked) timeslot for a service or, optionally, for specific service providers.

OneOffTimeslots v2

Create

Creates a one-off timeslot

Dynamic Fields v2

Create

Creates a dynamic field for bookings under a specific service.

ValidateDynamicFields

Validate dynamic fields

Otp v1

SendOtp

VerifyOtp

RefreshOtpToken

Events v2

Post

Create an event

Cancel

Cancel an event

CreateEventBooking

Book an event, as citizen / admin / agency For citizen, validate captcha

ValidateOnHoldBooking

Validates an on hold booking. It will add additional booking information to an existing booking and change the status of the booking

UpdateEventBookedSlotsAttendance

Update event booked slots which contains attendance data

Attendees Fields v2

Create

Creates a attendees fields for bookings under a specific service.

Service SMS Notification Template v2

CreateSMSNotificationTemplate

Creates a sms notification template for a service.

Service Group V2

Create

Creates a service group.

Schemas

CreateSchema

Creates a schema for bookings under a specific service.