vs-vapi

Tech Docs Home

Back

Repo Link

Jira Link

Projects Controller

• Definitions
• Brief
• Routes

Routes

• GETproject
• QUERYprojects
• CREATEproject
• UPDATEproject
• REMOVEproject

GETproject

Get the project with the id.

PASS:

• id - project id

QUERYprojects

Query Projects through options.query. A way to customize project queries. Anything allows through the mongomart, is allowed through options.

PASS

• query - allowed mongo query
• projection - (optional) what properties you want

CREATEproject

Takes in a whole project and an hhid to link to. Checks to see if the home exists. If the home exists the project is inserted into the database. On success, the project id is pushed home.activeProjects. If activeProjects can not be updated the project is deleted, and success=false returned.

PASS:

• project - any properties you want to have included in initial project
• project.dept - must have a valid department
• project.stage - must have a valid stage
• hhid - the home id. Must exist to create project

UPDATEproject

Update a project with a valid id. Update takes any valid property value or mongo update function ($push).

PASS

• id - customer id
• update - valid property or mongoDB functioning

REMOVEproject

Will remove a project from the database given the id and associated hhid. After a successful delete, the home is update and the taskmanager is notified of the deletion and cleaned.

PASS:

• id - work id
• hhid - home hhid