Skip to content

Latest commit

 

History

History
973 lines (900 loc) · 25.8 KB

README.md

File metadata and controls

973 lines (900 loc) · 25.8 KB
Raw

Background

The client describes the goals of the project as follows:

"There are dozens of collegiate level ballroom dance competitions that happen throughout the year. The aim of this project is to develop a system to manage these competitions. At present, the standard way (if not only way) to organize and manage the competition is through a service called O2CM. The interface is a nightmare for those hosting as well as those signing up.

"Cornell hosts a ballroom competition in the Fall. If the project is polished enough by the beginning of the Fall semester, we would be super excited to use it. The people who work with us that help host different competitions will probably see this implementation and bring it to the other competitions they host year-round."

Project Summary

Once a competition starts, there are several rounds of dancing, where about 20 couples dance on the floor. Judges walking around have to write down the numbers of the couples that they want to call back to the next round. At present, this is done with paper and pen, and someone has to take the time to enter all the numbers by hand. There are only a few minutes and lots of numbers to enter in before the next round starts. The system tallies them up and figures out who should be moving on to the next round. These results then need to be displayed on a projector so dancers can see if they made it or not.

The system needs to serve two categories of users and support them with a good back end to keep track of everything.

  • Competitors
    • Easy interface for competitors to register
    • Lead/follow, different partners
    • Way to see schedule of event
    • See callbacks
  • Organizers
    • Easy interface to look at competitors by school, event, how much they owe
    • Definable limits on what events a competitor can register for
    • Time based changing of prices for registration/deadlines
    • Define events (e.g., Newcomer Tango vs PreChamp Tango)

Database

To set up database, run psql -U postgres -d postgres -1 -f <path/to/db.sql>

APIs

API for viewing and updating database.

POST

  • Create a Competitor based on Auth0

    • URL : /api/create_user

    • Method : POST

    • Request : {body: { profile: string, firstname: string, lastname: string, email: string, mailingaddress: string, affiliationname： string } }

    • Response : {}

  • Update Competitor Information

    • URL : /api/update_competitor

    • Method : POST

    • Request : {body: { id: int, firstname: string, lastname: string, mailingaddress: string, affiliationid： int, hasregistered: bool } }

    • Response : {}

  • Create a Competition

    • URL : /api/create_competition
    • Method : POST
    • Request : {body: { name: string, leadidstartnum: int, locationname: string, earlyprice: float, regularprice: float, lateprice: float, startdate： date, enddate： date, regstartdate： date, earlyregdeadline: date, regularregdeadline: date, lateregdeadline: date, description: string, compadmin: string } }
    • Response: {id: int // id of newly created competition}

  • Create an Official

    • URL : /api/create_official
    • Method : POST
    • Request : {body: { token: string, firstname: string, lastname: string, roleid: int, competitionid: int } }
    • Response : {}

  • Delete an Official by id

    • URL : /api/delete_official
    • Method : POST
    • Request : {body: { id: int } }
    • Response : {}

  • Clear the Amount Owed by Organization

    • URL : /api/clear_organization_owed
    • Method : POST
    • Request : {body: { competitionid: int, affiliationid: int } }
    • Response : {}
    • Description : This sets all the amount owed for the given competition by competitors who have affiliated with the given organization and indicated to pay with organization to zero.

  • Create Payment Record

    • URL : /api/create_paymentrecord
    • Method : POST
    • Request : {body: { competitionid: int, competitorid: int, amount: float, online: bool, paidwithaffiliation: bool } }
    • Response : {}
    • Description : Nothing happens if the payment record is already created for the given competition and competitor pair.

  • Get the Amount Owed by an Organization

    • URL : /api/create_paymentrecord
    • Method : POST
    • Request : {body: { cid: int, // competition id aid: int // organization id } }
    • Response : {coalesce: float}
    • Description : This returns the total amount owed for the given competition by competitors who have affiliated with the given organization and indicated to pay with organizatio.

  • Create Partnership

    • URL : /api/create_partnership
    • Method : POST
    • Request : {body: { leadcompetitorid: int, followcompetitorid: int, eventid: int, competitionid: int } }
    • Response : {}

  • Delete Partnership

    • URL : /api/delete_partnership
    • Method : POST
    • Request : {body: { leadcompetitorid: int, followcompetitorid: int, eventid: int } }
    • Response : {}

  • Generates Rounds based on which Partnerships are signed up for which Events

    • URL : /api/competition/generateRounds
    • Method : POST
    • Request : {body: { eventid: int, name: string, ordernumber: int, size: int } }
    • Response : {}

  • Update Events for the current Competition

    • URL : /api/competition/updateEvents
    • Method : POST
    • Request : {body: { id: int, styleid: int, stylename: string, levelid: int, levelname: string, dance: string, ordernumber: int } }
    • Response : {}

  • Update Levels and Styles for the current Competition

    • URL : /api/competition/updateLevelsStyles
    • Method : POST
    • Request : {body: { id: int, name: string, ordernumber: int } }
    • Response : {}

  • Update Rounds for the current Competition

    • URL : /api/competition/updateRounds
    • Method : POST
    • Request : {body: { id: int, levelid: int, levelname: string, styleid: int, stylename: string, dance: string, eventid: int, name: string, ordernumber: int, size: int, callbackscalculated: bool } }
    • Response : {}

  • Update the current Competition

    • URL : /api/competition/updateCompetitionInfo
    • Method : POST
    • Request : {body: { id: int, name: string, leadidstartnum: string, locationname: string, earlyprice: float, regularprice: float, lateprice: float, startdate: date, enddate: date, regstartdate: date, earlyregdeadline: date, regularregdeadline: date, lateregdeadline: date, description: string } }
    • Response : {}

  • Update the current Competition Round id

    • URL : /api/competition/updateCompetitionCurrentRoundId
    • Method : POST
    • Request : {body: { cid: int, rid: int } }
    • Response : {}

  • Update a Payment Record

    • URL : /api/payment_records/update/
    • Method : POST
    • Request : {body: { competitionid: int, competitorid: int, amount: float, online: bool, paidwithaffiliation: bool } }
    • Response : {}

GET

  • Get a Competition by id

    • URL : /api/competition/:id
    • Method : GET
    • Request : {body: { id: int // id of competition } }
    • Response :
      { id: int, name: string, leadidstartnum: int, locationname: string, earlyprice: float, regularprice: float, lateprice: float, startdate: date, enddate: date, regstartdate: date, earlyregdeadline: date, regularregdeadline: date, lateregdeadline: date, compadmin: string, currentroundid: int, description: string }

  • Get the Affiliations for a Competition

    • URL : /api/competition/:cid/affiliations
    • Method : GET
    • Request : {body: { cid: int // id of competition } }
    • Response :
      { affiliationname: string }

  • Get an Affiliation by id

    • URL : /api/affiliations/:id
    • Method : GET
    • Request : {body: { id: int // id of affiliation } }
    • Response :
      { id: int, name: string }

  • Get the Competitors for a Competition

    • URL : /api/competition/:cid/competitors
    • Method : GET
    • Request : {body: { cid: int, // id of competition } }
    • Response :
      { id: int, name: string email: string, number: int, affiliationname: name, paidwithaffiliation: bool amount: bool }

  • Get the number of Competitors per Style for a Competition

    • URL : /api/competition/:cid/competitors_styles
    • Method : GET
    • Request : {body: { cid: int, // id of competition } }
    • Response :
      { count: int, name: string, }

  • Get the Events for a Competition

    • URL : /api/competition/:cid/events
    • Method : GET
    • Request : {body: { cid: int,// id of competition } }
    • Response :
      { id : int, stylename: string, levelname: string, dance: string, ordernumber: int }

  • Get the Officials of a Competition

    • URL : /api/competition/:cid/officials
    • Method : GET
    • Request : {body: { cid: int // id of competition } }
    • Response :
      { id: int, token: string, firstname: string, lastname: string, roleid: int, competitionid: int, rolename: string }

  • Get the Adjudicators of a Competition

    • URL : /api/competition/:cid/judges
    • Method : GET
    • Request : {body: { cid: int // id of competition } }
    • Response :
      { id: int, token: string, firstname: string, lastname: string, roleid: int, competitionid: int }

  • Get the Levels of a Competition

    • URL : /api/competition/:cid/levels
    • Method : GET
    • Request : {body: { cid: int // id of competition } }
    • Response :
      { id: int, name: string, ordernumber: int }

  • Get the Styles for a Competition and Level

    • URL : /api/competition/:cid/level/:lid/styles
    • Method : GET
    • Request : {body: { cid: int, // id of competition lid: int, // id of level } }
    • Response :
      { id: int, name: string, ordernumber: int }

  • Get the Events for a Competition, Level, and Style

    • URL : /api/competition/:cid/level/:lid/style/:sid
    • Method : GET
    • Request : {body: { cid: int, // id of competition lid: int, // id of level sid: int // id of style } }
    • Response :
      { id: int, dance: string, stylename: string, levelname: string, ordernumber: int }

  • Get the Rounds of a Competition

    • URL : /api/competition/:cid/rounds
    • Method : GET
    • Request : {body: { cid: int // id of competition } }
    • Response :
      { id: int, levelname: string, levelorder: int, stylename: string, styleorder: int, dance: string, eventorder: int, round: string, ordernumber: int, size: int, callbackscalculated: bool, eventid: int }

  • Get the Styles of a Competition

    • URL : /api/competition/:cid/styles
    • Method : GET
    • Request : {body: { cid: int // id of competition } }
    • Response :
      { id: int, name: string, ordernumber: int }

  • Get a Competitor by id

    • URL : /api/competitors/:id
    • Method : GET
    • Request : {body: { id: int // id of competitor } }
    • Response :
      { id: int, firstname: string, lastname: string, email: string, mailingaddress: string, affiliationid: int, hasregistered: bool, affiliationname: string number: int }

  • Get all the Competitors

    • URL : /api/competitors/
    • Method : GET
    • Request : {body: {} }
    • Response :
      { id: int, firstname: string, lastname: string, email: string, mailingaddress: string, affiliationid: int, hasregistered: bool }

  • Get the Competitor numbers in a Round

    • URL : /api/competitors/round/:rid
    • Method : GET
    • Request : {body: { rid: int // id of round } }
    • Response :
      { number: int }

  • Get the confirmed Partnerships for the Competitor in the Competition

    • URL : /api/competitors/:id/:cid/events
    • Method : GET
    • Request : {body: { id: int, // id of competitor cid: int, // id of competition } }
    • Response :
      { leadcompetitorid: int, followcompetitorid: int, eventid: int, leadconfirmed: bool, followconfirmed: bool, competitionid: int, number: int, calledback: bool, timestamp: date, dance: string, eventid: int, style: string, level: string, leadfirstname: string, leadlastname: string, followfirstname: string, followlastname: string }

  • Get all the Competitions the Admin is associated with

    • URL : /api/competitions/:email
    • Method : GET
    • Request : {body: { email: string // email address of admin } }
    • Response :
      { id: int, name: string, leadidstartnum: int, locationname: string, earlyprice: float, regularprice: float, lateprice: float, startdate: date, enddate: date, regstartdate: date, earlyregdeadline: date, regularregdeadline: date, lateregdeadline: date, compadmin: string, currentroundid: int, description: string }

  • Get all the Competitions

    • URL : /api/competitions
    • Method : GET
    • Request : {body: {} }
    • Response :
      { id: int, name: string, leadidstartnum: int, locationname: string, earlyprice: float, regularprice: float, lateprice: float, startdate: date, enddate: date, regstartdate: date, earlyregdeadline: date, regularregdeadline: date, lateregdeadline: date, compadmin: string, currentroundid: int, description: string }

  • Get the Competitions a Competitor is registered for

    • URL : /api/competitions/:cid/
    • Method : GET
    • Request : {body: { cid: int // id of competition } }
    • Response :
      { id: int, name: string, leadidstartnum: int, locationname: string, earlyprice: float, regularprice: float, lateprice: float, startdate: date, enddate: date, regstartdate: date, earlyregdeadline: date, regularregdeadline: date, lateregdeadline: date, compadmin: string, currentroundid: int, description: string }

  • Get the Competitions a Competitor is not registered for

    • URL : /api/competitions/:cid/unregistered
    • Method : GET
    • Request : {body: { cid: int // id of competitor } }
    • Response :
      { id: int, name: string, leadidstartnum: int, locationname: string, earlyprice: float, regularprice: float, lateprice: float, startdate: date, enddate: date, regstartdate: date, earlyregdeadline: date, regularregdeadline: date, lateregdeadline: date, compadmin: string, currentroundid: int, description: string }

  • Get an Event by id

    • URL : /api/event/:eid/
    • Method : GET
    • Request : {body: { eid: int } }
    • Response :
      { id: int, competitionid: int, styleid: int, levelid: int, dance: string, ordernumber integer }

  • Get all the Rounds in the same Event as a specified Round

    • URL : /api/event/rounds/:rid
    • Method : GET
    • Request : {body: { rid: int } }
    • Response :
      {body: { id: int, eventid: int, name: string, ordernumber: int, size: int, callbackscalculated: bool, levelname: string, stylename: string, dance: string } }

  • Get all the Affiliations

    • URL : /api/affiliations
    • Method : GET
    • Request : {body: {} }
    • Response :
      { id: int, name: string }

  • Get all the Payment Records

    • URL : /api/payment_records
    • Method : GET
    • Request : {body: {} }
    • Response :
      { id: int, competitionid: int, timestamp: date, competitorid: int, amount: float, online: bool, paidwithaffiliation: bool }

  • Get the Payment Records for a Competition

    • URL : /api/payment_records/competition/:id

    • Method : GET

    • Request : {body: { int: id // competition id } }

    • Response :
      { id: int, competitionid: int, timestamp: date, competitorid: int, amount: float, online: bool, paidwithaffiliation: bool }

  • Get the Payment Records for a Competitor

    • URL : /api/payment_records/:competitionid/:competitorid

    • Method : GET

    • Request : {body: {                competitionid: int, competitorid: int } }

    • Response :
      { id: int, competitionid: int, timestamp: date, competitorid: int, amount: float, online: bool, paidwithaffiliation: bool }

  • Get the Payment Record for a Competition and Competitor

    • URL : /api/payment_records/:competitionid/:competitorid

    • Method : GET

    • Request : {body: { competitionid: int, competitorid: int } }

    • Response :
      { id: int, competitionid: int, timestamp: date, competitorid: int, amount: float, online: bool, paidwithaffiliation: bool }

  • Update the Callbacks of a Judge for a Round

    • URL : /api/callbacks/update

    • Method : POST

    • Request : {body: {} }

    • Response :
      {}

  • Calculate the Callbacks for a Round

    • URL : /api/callbacks/calculate

    • Method : POST

    • Request : {body: {} }

    • Response :
      {}

    • Description : This determines the competitors that will be called back to the next round and then updates the calledback status of eliminated competitors to false and the callbackscalculated status of the round to true.

  • Get all the Admins

    • URL : /api/admins
    • Method : GET
    • Request : {body: {} }
    • Response :
      { email: string }

  • Get all the Roles

    • URL : /api/roles
    • Method : GET
    • Request : {body: {} }
    • Response :
      { id: int, name: string }

  • Get an Official by id

    • URL : /api/officials/:id
    • Method : GET
    • Request : {body: { id: int } }
    • Response : { id: int, token: string, firstname: string, lastname: string, roleid: int, comeptitionid: int, rolename: string }

  • Get the Judges who submitted their Callbacks for a certain Round

    • URL : /api/judges/round/:rid
    • Method : GET
    • Request : {body: { rid: int, // round id } }
    • Response :
      { id: int, firstname: string, lastname: string, }