Skip to main content

Booking Service

The Booking Service defines the structure and rules for appointments in the system. It acts as a blueprint for creating future appointments, specifying essential parameters such as duration, scheduling windows, and service conditions.

Overview​

A booking service allows you to:

  • Define appointment durations and buffer times
  • Set scheduling time constraints
  • Configure resource allocation rules
  • Customize additional fields for specific requirements
  • Manage calendar associations

Authentication​

All Service API endpoints require authentication using the ONLIVESITE authentication scheme. Include the following header in all requests:

Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

Available Endpoints​

Service Management​

  • Create Service - Create a new booking service
  • Get Service - Retrieve details of a specific service
  • List Services - Get a paginated list of services with optional filters
  • Update Service - Modify an existing service's configuration
  • Delete Service - Remove a service from the system

Calendar Association​

  • Add Calendar - Associate a calendar with a service
  • Remove Calendar - Remove a calendar association
  • Update Calendar Settings - Modify calendar-specific settings for a service

Common Use Cases​

  • Creating standardized appointment types
  • Setting up service schedules
  • Managing resource allocation
  • Configuring booking rules and restrictions
  • Organizing services by type and organization

For detailed information about specific operations, please refer to the individual endpoint documentation sections.