Module: routers/users

Express router providing user related routes
Source:

Requires

  • module:express

Methods

(inner) DELETE /courses/course() → {String}

Routing serving deleting a course
Source:
Returns:
msg - success or failure
Type
String

(inner) DELETE /jobPosting() → {string}

Routing serving retrieving a job posting by id
Properties:
Name Type Description
id string the job posting id
Source:
Returns:
message - success message
Type
string

(inner) DELETE /profile/career() → {string}

Routing serving removing a career
Properties:
Name Type Description
id string the id of the career
Source:
Returns:
message - success message
Type
string

(inner) DELETE /profile/education() → {string}

Routing serving removing an education
Properties:
Name Type Description
id string the id of the education
Source:
Returns:
message - success message
Type
string

(inner) GET /courses/search() → {String}

Routing serving finding a course
Source:
Returns:
msg - success or failure
Type
String

(inner) GET /jobPostings() → {string}

Routing serving retrieving an organization's job postings
Properties:
Name Type Description
user string the user session
Source:
Returns:
array - job postings
Type
string

(inner) GET /jobs/jobposting() → {string}

Routing serving retrieving a job posting by id
Properties:
Name Type Description
id string the job posting id
Source:
Returns:
message - success message
Type
string

(inner) GET /logout() → {json}

Routing serving logout
Source:
Returns:
text of Successfully logged out
Type
json

(inner) GET /profile() → {string|string|Date}

Routing serving getting profile information
Source:
Returns:
  • firstname - the first name
    Type
    string
  • lastname - the last name
    Type
    string
  • dob - the date of birth
    Type
    Date

(inner) GET /profile/usertype() → {string}

Routing serving retrieving logged in user's usertype
Source:
Returns:
message - the usertype
Type
string

(inner) GET /skills() → {Array}

Routing serving adding a skill
Source:
Returns:
skills - all skills in database
Type
Array

(inner) GET /skills() → {Array}

Routing serving searching for skills
Source:
Returns:
skills - all skills in search results
Type
Array

(inner) GET /skills/getSkills() → {Object}

Routing serving getting singular skill by id
Source:
Returns:
skill - matching skill
Type
Object

(inner) GET /skills/getSkills() → {Object}

Routing serving getting singular skill by id
Source:
Returns:
skill - matching skill
Type
Object

(inner) PATCH /courses/course() → {String}

Routing serving updating a course
Source:
Returns:
msg - success or failure
Type
String

(inner) PATCH /jobPosting() → {string}

Routing serving retrieving a job posting by id
Properties:
Name Type Description
id string the job posting id and edits
Source:
Returns:
message - success message
Type
string

(inner) PATCH /profile/career() → {string}

Routing serving updating a career
Properties:
Name Type Description
id string the id from the career object
career string the career object
Source:
Returns:
message - success message
Type
string

(inner) PATCH /profile/education() → {string}

Routing serving updating an education
Properties:
Name Type Description
id string the id of the education
education string the education object getting updated
Source:
Returns:
message - success message
Type
string

(inner) POST /courses() → {List}

Routing serving viewing all the user's courses (educator only)
Source:
Returns:
courses - list of course objects
Type
List

(inner) POST /courses/course() → {String}

Routing serving adding a course
Source:
Returns:
msg - success or failure
Type
String

(inner) POST /jobPosting() → {string}

Routing serving retrieving a job posting by id
Properties:
Name Type Description
id string the job posting id
Source:
Returns:
message - success message
Type
string

(inner) POST /jobs/createjobposting() → {string}

Routing serving retrieving a job posting by id
Properties:
Name Type Description
id string the job posting id
Source:
Returns:
message - success message
Type
string

(inner) POST /login() → {json}

Routing serving login
Properties:
Name Type Description
username string the email of the account to login
password string the password of the account to login
Source:
Returns:
returns the user.username upon success and Unauthorized on failure
Type
json

(inner) POST /profile() → {string}

Routing serving updating profile information
Properties:
Name Type Description
firstname string the first name
lastname string the last name
dob string the date of birth YYYY/MM/DD
Source:
Returns:
message - success message
Type
string

(inner) POST /profile/career() → {string}

Routing serving adding a career
Properties:
Name Type Description
jobTitle string the jobtitle
endDate string the end date of the job
startDate string the state date of the job
organization string the organization name
Source:
Returns:
message - success message
Type
string

(inner) POST /profile/career() → {string}

Routing serving retrieving a job posting by id
Properties:
Name Type Description
zip_code string the zip_code to search in
skills string a list of skills string
Source:
Returns:
message - success message
Type
string

(inner) POST /profile/education() → {string}

Routing serving adding an education
Properties:
Name Type Description
degree string the degree type
major string the major
gradDate string the graduation date
organization string the organization/college name
Source:
Returns:
message - success message
Type
string

(inner) POST /profile/skill() → {string}

Routing serving adding a skill
Properties:
Name Type Description
skill string the skill
Source:
Returns:
message - success message
Type
string

(inner) POST /register() → {json}

Routing serving registration
Properties:
Name Type Description
username string the email for the new account
password string the password for the new account
usertype string the usertype for the new account (EducatorProfile, EmployerProfile, JobSeekerProfile)
Source:
Returns:
Success or Failure message
Type
json