Skip to content

Endpoints and their Parameters (Deliverable 2)

ProEo edited this page Mar 4, 2019 · 3 revisions

Getting one specific object from the database

Object GET (Heroku Address) Parameter(s) Format of Parameter
CoopPlacementForm /CoopPlacementForm/{id} Unique ID Integer
CoopPosition /CoopPosition/{id} Unique ID Integer
Employer /Employer/{id} Unique ID Integer
EvaluationForm /EvaluationForm/{id} Unique ID Integer
Event /Event/{name} Name String
StartConfirmation /StartConfirmation/{id} Unique ID Integer
Student /Student/{id} Unique ID Integer
TaxCreditForm /TaxCreditForm/{id} Unique ID Integer

Getting ALL the Object of the same type from the database

Object GET (Heroku Address) Parameter(s) Format of Parameter
CoopPlacementForm /CoopPlacementForm None None
CoopPosition /CoopPosition None None
Employer /Employer None None
EvaluationForm /EvaluationForm None None
Event /Event None None
StartConfirmation /StartConfirmation None None
Student /Student None None
TaxCreditForm /TaxCreditForm None None

Creating an object in the database

Object POST (Heroku Address) Parameter(s) Format of Parameter
CoopPlacementForm /CoopPlacementForm/{id} Unique ID Integer
CoopPosition /CoopPosition/{id} PositionName,CompanyName, Start and End Date String,String,yyyy-mm-dd,yyyy-mm-dd
Employer /Employer/{id} Username and Password String
Student /Student/{id} Student Name String
TaxCreditForm /TaxCreditForm/{id} Unique ID Integer

Updating an Existing Object in the database

Object+ Object child POST (Heroku Address) Parameter(s) Format of Parameter Objective
CoopPosition and CoopPlacementForm /updateCoopPosition coopPositionID and coopPlacementFormID Integer Update CoopPlacementForm in CoopPosition
CoopPosition and StartConfirmation /updateCP coopPositionID and StartConfirmationID Integer Update StartConfirmation in CoopPosition
CoopPosition and taxCreditForm /updateCoop coopPositionID and taxCreditFormID Integer Update TaxCredit in CoopPosition
CoopPosition and EvaluationForm /updateCoopP coopPositionID and evaluationFormID Integer Update EvaluationForm in CoopPosition
CoopPosition and Student /updateCoopStudent coopPositionID and studentID Integer Update Student in CoopPosition
Employer and StartConfirmation /updateEmployer employerID and startConfirmationID Integer Update StartConfirmation in Employer
Employer and Evaluation form /updateEmployerEvaluationForm employerID and evaluationFormID Integer Update EvaluationForm in Employer