Saltar al contenido principal

Appointments

The Appointments API provides comprehensive endpoints for managing calendar appointments in the Onlive system. These endpoints allow you to create, retrieve, update, and delete appointments, as well as manage related features like reminders, guests, and voting.

🔐 Authentication​

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

Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

📌 Available Endpoints​

Appointment Management (v2)​

  • Create Appointment — POST /api/v2/appointments
  • Get Appointment — GET /api/v2/appointments/{id}
  • List Appointments — GET /api/v2/appointments
  • Update Appointment — PUT /api/v2/appointments/{id}
  • Cancel Appointment — POST /api/v2/appointments/{id}/cancel
  • Delete Appointment — DELETE /api/v2/appointments/{id}

Additional Features (v2)​

  • Appointment Votes — GET /api/v2/appointments/{id}/votes
  • Mask Guests (TBD) — PUT /api/v2/appointments/{id}/mask-guests

💡 Common Use Cases​

  • Scheduling one-time or recurring appointments
  • Managing appointment reminders and notifications
  • Adding and managing appointment guests
  • Handling appointment reviews and feedback
  • Appointment search and filtering
  • Calendar integration and synchronization

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