Skip to content

Plan an event with friends, group of strangers the API-way!

Notifications You must be signed in to change notification settings

davidseow/availability

Repository files navigation

availability

Plan an event with friends, group of strangers the API-way!

Journey

  1. [Organiser] Create an event (it should include a list of participants and date & time slots)
  2. [Participants] Select preferred time slots
  3. [All] Retrieve results. Voting ends when all participants have voted

API

Create event

POST /event
{
  name: <string>
  description:  <string>
  timeSlots: [<timestamp>,..],
  duration: <number>,
  participants: [<string>, <string>]
}

Select preferred slots

PUT /event/<id>
{
  participant: <string>
  selectedTimeSlots: [<timestamp>,..]
}

View list available time slots and results

GET /event/<id>

Response
{
    name: <string>,
    description: <string>,
    timeSlots: [<timestamp>,..],
    duration: <number>,
    participants: [<string>, <string>],
    selectedTimeSlots?: [<timestamp>,..],
    voted?: [<string>, <string>]
  }

About

Plan an event with friends, group of strangers the API-way!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published