Overview

What is a Booking?

A booking in the context of Sched is a scheduled appointment between a resource (such as a person, location, or equipment) and a client or user. The booking system is designed to manage the availability of resources and allows users to reserve specific time slots.

Key Components of a Booking

A booking typically involves several key components:

1. Resource: This is the entity that is being booked. It could be a meeting room, a service provider, or any other resource that has availability and can be reserved.

2. Time Slot: This represents the specific time and date for which the resource is being booked. The time slot ensures that the resource is reserved for the client during the specified period.

3. Client/User: The person or entity making the booking. This could be an individual user or another system that interacts with the API to schedule an appointment.

4. Booking Details: Additional information related to the booking, such as the purpose of the booking, any special requirements, or other metadata that may be useful for the resource or service provider.

Booking Lifecycle

Bookings typically follow a lifecycle that includes the following stages:

1. Creation: A booking is created when a client or user selects a resource and a time slot. The booking may be confirmed immediately or may require approval from the resource owner.

2. Modification: Depending on the rules set by the resource or service provider, a booking may be modified to change the time, resource, or details.

3. Cancellation: A booking can be canceled by the client or, in some cases, by the resource owner if necessary. The cancellation may trigger notifications or workflows depending on the system's configuration.

4. Completion: Once the booked time has passed and the service or resource has been utilized, the booking is marked as complete. In some cases, feedback or follow-up actions may be required.

API Operations Related to Bookings

The Sched API provides several operations related to bookings:

1. Create Booking (POST /bookings):

   • This endpoint allows users to create a new booking by specifying the resource, time slot, and any other relevant details.
   • Example Payload:
     JSON

     {
         "resource_id": "uuid",
         "start_time": "2024-05-18T10:00:00Z",
         "end_time": "2024-05-18T11:00:00Z",
         "client_id": "uuid",
         "details": "Meeting regarding project updates"
     }
     

2. Get Booking (GET /bookings/{booking_id}):

   • Retrieve the details of a specific booking using its unique identifier.
   • Response Example:
     JSON

     {
         "booking_id": "uuid",
         "resource_id": "uuid",
         "start_time": "2024-05-18T10:00:00Z",
         "end_time": "2024-05-18T11:00:00Z",
         "client_id": "uuid",
         "status": "confirmed",
         "details": "Meeting regarding project updates"
     }
     

3. Update Booking (PUT /bookings/{booking_id}):

   • Allows modification of an existing booking. Only certain fields may be modifiable depending on the system's rules.
   • Example Payload:
     JSON

     {
         "start_time": "2024-05-18T10:30:00Z",
         "end_time": "2024-05-18T11:30:00Z",
         "details": "Updated meeting time"
     }
     

4. Cancel Booking (DELETE /bookings/{booking_id}):

   • This operation cancels an existing booking, making the resource available for others during the previously reserved time slot.

Use Cases for Bookings

Bookings are essential in various scenarios, including but not limited to:

• Healthcare: Scheduling appointments with doctors, therapists, or other healthcare providers.
• Education: Reserving time slots for tutoring sessions, classes, or study rooms.
• Corporate: Booking meeting rooms, equipment, or even scheduling interviews.
• Services: Scheduling time for service providers such as consultants, trainers, or freelancers.

Conclusion

The booking system in Sched is a powerful tool designed to manage and optimize the allocation of resources. Whether you're managing a single calendar or coordinating multiple resources across different locations, the API provides the flexibility and control needed to build efficient scheduling solutions.

Next Steps

• Explore the API Endpoints: Dive into the API documentation to explore the various operations you can perform with bookings.
• Try It Out: Use the API to create, modify, and manage bookings as per your requirements.