Skip to content

Data Types

Kavita Kapoor edited this page Apr 19, 2021 · 15 revisions

This section documents the two user types, the data types and associated API.

User Types

  • Username
  • Email
  • Full Name
  • Photo or avatar

Volunteer

  • Description
  • The list of Opportunities they have indicated interest
  • Skills
  • Organisation where the Volunteer works
  • Background check date
  • Background check document
  • Any Organizer added notes

Organizer

  • Opportunities organizing new * Organisation

new Organizer

  • NGO or Charity

Opportunities

  • Time/Date
  • Skills required
  • Title
  • Description
  • Organizer (see organizer)
  • Location
  • Personnel needed
  • Commitment type (one time, recurring, etc)
  • background checks requirements
  • Image of opportunity to make it stand out
  • Clothing requirements (T-shirt size or Waders for clean up)
  • The Tasks is Public, Private, or Unlisted
  • Training requirements (see training)

Opportunities Feedback

  • Feedback Text
  • Images
  • Mark complete

Training Details

  • Date of Training
  • Link to Online Training Course
  • Name of Training

Training Attended

  • Training Detail Reference
  • Volunteer Reference
  • Scores
  • Attendance

API

Each data type above has an associated CRUD based.

  • USER
  • Volunteer
  • Organizer
  • Opportunities
  • Training Details
  • Training Attended

Clone this wiki locally