Activity API Documentation

This document provides comprehensive documentation of the Activity API including descriptions, request methods, endpoints, parameters, and example requests and responses.

Endpoints Overview

• Create Activity: Create a new activity.
• Get Activity: Retrieve details about a specific activity.
• Get Activity Dates: Retrieve dates associated with a specific activity.
• Create Attendee: Add an attendee to an activity.
• Create Attendee Date: Associate a date with an attendee for an activity.
• Delete Attendee Date: Remove a date association from an attendee for an activity.

Create Activity

• Method: POST
• Endpoint: /api/activities
• Parameters:
  • name (required): The name of the activity.
• Example Request:

  curl -X POST http://example.com/api/activities \
  -H "Content-Type: application/json" \
  -d '{"name": "Picnic"}'
  

• Example Response:

  {
      "id": "activity-public-id",
      "name": "Picnic"
  }
  

Get Activity

• Method: GET
• Endpoint: /api/activities/{activityId}
• Path Parameters:
  • activityId (required): The public ID of the activity.
• Example Request:

  curl http://example.com/api/activities/activity-public-id
  

• Example Response:

  {
      "id": "activity-public-id",
      "name": "Picnic",
      "dates": [],
      "attendees": []
  }
  

Get Activity Dates

• Method: GET
• Endpoint: /api/activities/{activityId}/dates
• Path Parameters:
  • activityId (required): The public ID of the activity.
• Query Parameters:
  • start (optional): Start date filter.
  • end (optional): End date filter.
  • full-attendees (optional): Include full attendee details. Values: true, false.
• Example Request:

  curl "http://example.com/api/activities/activity-public-id/dates?start=2023-01-01&end=2023-01-31&full-attendees=true"
  

• Example Response:

  [
      {
          "date": "2023-01-15",
          "attendee": {
              "id": "attendee-public-id",
              "name": "John Doe"
          },
          "activity": "activity-public-id"
      }
  ]
  

Create Attendee

• Method: POST
• Endpoint: /api/activities/{activityId}/attendees
• Path Parameters:
  • activityId (required): The public ID of the activity.
• Parameters:
  • name (required): Name of the attendee.
• Example Request:

  curl -X POST http://example.com/api/activities/activity-public-id/attendees \
  -H "Content-Type: application/json" \
  -d '{"name": "John Doe"}'
  

• Example Response:

  {
      "id": "attendee-public-id",
      "name": "John Doe",
      "created": true
  }
  

Create Attendee Date

• Method: POST
• Endpoint: /api/activities/{activityId}/attendees/{attendeeId}/dates
• Path Parameters:
  • activityId (required): The public ID of the activity.
  • attendeeId (required): The public ID of the attendee.
• Parameters:
  • date (required): Date to be associated with the attendee.
• Example Request:

  curl -X POST http://example.com/api/activities/activity-public-id/attendees/attendee-public-id/dates \
  -H "Content-Type: application/json" \
  -d '{"date": "2023-01-15"}'
  

• Example Response:

  {
      "date": "2023-01-15",
      "activity": "activity-public-id",
      "attendee": "attendee-public-id"
  }
  

Delete Attendee Date

• Method: DELETE
• Endpoint: /api/activities/{activityId}/attendees/{attendeeId}/dates/{date}
• Path Parameters:
  • activityId (required): The public ID of the activity.
  • attendeeId (required): The public ID of the attendee.
  • date (required): Date to be removed.
• Example Request:

  curl -X DELETE http://example.com/api/activities/activity-public-id/attendees/attendee-public-id/dates/2023-01-15
  

• Example Response:

  true
  

This documentation covers the primary operations of the Activity API, aiming to provide sufficient information for interacting with the endpoints effectively.