Droom API

Back-end build week project for droom

Deployed Backend

https://droom-build-week.herokuapp.com/

Production

Express: Fast, unopinionated, minimalist web framework for Node.js
Body parser: Parse incoming request bodies in a middleware before your handlers
Bcryptjs: Allows you to store passwords securely in your database
Jsonwebtoken: Generate and verify json web tokens to maintain a stateless api
Knex: Knex.js is a "batteries included" SQL query builder for Postgres, MSSQL, MySQL, MariaDB, SQLite3, Oracle, and Amazon Redshift designed to be flexible, portable, and fun to use
Knex-cleaner: Helper library to clean a PostgreSQL, MySQL or SQLite3 database tables using Knex
Sqlite3: Asynchronous, non-blocking SQLite3 bindings for Node.js.
Morgan: HTTP request logger middleware for Node.js
Cors: CORS is a Node.js package for providing a Connect/Express middleware that can be used to enable CORS
Helmet: Helmet helps you secure your Express apps by setting various HTTP headers
Dotenv: Dotenv is a zero-dependency module that loads environment variables from a .env file

Developer

Nodemon: nodemon is a tool that helps develop Node.js based applications by automatically restarting the node application when file changes in the directory are detected

Setup

(# <--- signifies comment)

In your terminal run:

# Install dependencies
npm install

# Starts express server using nodemon
npm run server

Test User Accounts
Summary Table of API Endpoints
Auth Routes
- Login User
- Register User
Applicant Routes
Education Routes
Experience Routes
Skills Routes
Company Routes
Job Routes
- Get Jobs
- Get Job
- Add Job
- Update Job
- Delete Job
Job Skills Routes
Match Routes

Test User Accounts

Job Applicant Accounts

Arshak Smith

email: [email protected]
password: password

Tigran Dough

email: [email protected]
password: password

Gene Jones

  email: [email protected]
  password: password

Company Accounts

Microsoft

  email: [email protected]
  password: password

Apple

email: [email protected]
password: password

Github

email: [email protected]
password: password

SUMMARY TABLE OF API ENDPOINTS

Table	Method	Endpoint	Description
users	POST	/api/auth/register	Creates a new `user` profile using the information sent inside the `body` of the request and returns a message along with the new `user` and a JSON Web Token in the `body` of the response.
users	POST	/api/auth/login	Uses the credentials sent inside the `body` to authenticate the user. On successful login, returns a message with the `user` profile and a JSON Web Token token in the `body` of the response.

AUTH ROUTES

REGISTER

Registers a user

Method Url: /api/auth/register

HTTP method: [POST]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json

Body

name	type	required	description
`email`	String	Yes	Must be unique
`password`	String	Yes

example:


{
  "email": "[email protected]"
  "password": "password123",
}

Response

201 (Created)

If you successfully register a user the endpoint will return an HTTP response with a status code 201 and a body as below.

example:


{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI3IkpXVCJ9.eyJpZCI6MSwiaWF0IjoxNTQ0MzM1NjUxLCJleHAiOjE1NzU4OTMyNTF9.uqd2OHBYkGQpwjLTPPiPWYkYOKlG7whQDFkk46xFXoX"
}

400 (Bad Request)

If you are missing a email or password for registration, the endpoint will return an HTTP response with a status code 400 and a body as below.

example:


{
  "message": "Oops, looks like this email already exists"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while registering"
}

LOGIN

Logs a user in

Method Url: /api/auth/login

HTTP method: [POST]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json

Body

name	type	required	description
`email`	String	Yes	Must match a email in the database
`password`	String	Yes	Must match a password in the database corresponding to email above

example:


{
  "email": "[email protected]"
  "password": "password123",
}

Response

200 (OK)

If you successfully login, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MDwiaWF0IjoxNTQ0MzM1NjUxLCJleHAuOjE1NzU4OTMyNTF9.uqd2OHBYkGQpwjLTPPiPWYkYOKlG7whQDFkk46xGXnE",
}

401 (Unauthorized)

If you failt to login, the endpoint will return an HTTP response with a status code 401 which indicates the email and or password entered is not valid.

example:


{
  message: "Oops, username or password is incorrect"
}

500 (Bad Request)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while logging in"
}

APPLICANT ROUTES

GET APPLICANT

Get applicant profile by user id

Method Url: /api/applicants/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Response

200 (OK)

If the user profile is found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "id": 1,
  "userId": 1,
  "firstName": "John",
  "lastName": "Dough",
  "profilePicture": "",
  "month": 2,
  "day": 4,
  "year": 1994,
  "country": "US",
  "state": "California",
  "city": "San Francisco",
  "zipcode": 93552
}

404 (Not Found)

If the provided userId doesn't have a profile, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Sorry, but that profile doesn't exist"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Sorry, but something went wrong while getting that profile"
}

ADD applicant

Add an applicant

Method Url: /api/applicants

HTTP method: [POST]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Body

name	type	required	description
`userId`	Integer	Yes	Must match a user's id in the database
`firstName`	String	Yes	Cannot be an empty field
`lastName`	String	Yes	Cannot be an empty field
`country`	String	Yes	Cannot be an empty field
`state`	String	Yes	Cannot be an empty field
`city`	String	Yes	Cannot be an empty field
`zipcode`	Integer	Yes	Cannot be an empty field
`address`	String	Yes	Cannot be an empty field

example:


{
  "userId": 1,
  "applicant": {
    "firstName": "Arshak",
    "lastName": "Smith",
    "country": "US",
    "state": "California",
    "city": "San Francisco",
    "zipcode": 93552,
    "address": "123 Abc St"
  }
}

Response

201 (Created)

If you successfully create a applicant profile, the endpoint will return an HTTP response with a status code 201 and a body as below.

example:


{
    "id": 1,
    "firstName": "Arshak",
    "lastName": "Smith",
    "country": "US",
    "state": "California",
    "city": "San Francisco",
    "zipcode": 93552,
    "address": "123 Abc St"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while creating your profile"
}

UPDATE APPLICANT

Update a applicant by user id

Method Url: /api/applicants/:id

HTTP method: [PUT]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific applicant

Body

name	type	required	description
`firstName`	String	Yes	Cannot be an empty field
`lastName`	String	Yes	Cannot be an empty field
`country`	String	Yes	Cannot be an empty field
`state`	String	Yes	Cannot be an empty field
`city`	String	Yes	Cannot be an empty field
`zipcode`	Integer	Yes	Cannot be an empty field
`address`	String	Yes	Cannot be an empty field

example:


{
  "firstName": "Arshak Updated",
  "lastName": "Dough",
  "country": "US",
  "state": "California",
  "city": "San Francisco",
  "zipcode": 93552,
  "address": "123 ABC st."
}

Response

200 (OK)

If a applicant with the specified ID in the URL parameters is updated successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "firstName": "Arshak Updated",
  "lastName": "Dough",
  "country": "US",
  "state": "California",
  "city": "San Francisco",
  "zipcode": 93552,
  "address": "123 ABC st."
}

404 (Not Found)

If the applicant profile for the specified id can't be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like that profile exists"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while updating this profile"
}

DELETE APPLICANT

Delete a applicant by user id

Method Url: /api/applicants/:id

HTTP method: [DELETE]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific applicant

Response

200 (OK)

If a applicant with the specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "message": "Profile successfully deleted"
}

404 (Not Found)

If the applicant profile for the specified id can't be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like that profile exists"
}

500 (Bad Request)

If you send in invalid fields, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while deleting this profile
}

EDUCATION ROUTES

GET EDUCATION

Get education by user id

Method Url: /api/education/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Response

200 (OK)

If applicant education is found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


[
  {
    "id": 1,
    "applicantId": 1,
    "eduSchool": "Cleveland State University",
    "eduDegree": "Bachelor of Science in Electrical Engineering",
    "eduDescription": "Electrical Engineering is a profession that makes creative use of mathematics and science to solve practical problems in electricity, electronics and related areas. The goal of the Electrical Engineering program at SFSU is to provide students with a practical, hands-on education that emphasizes applications.",
    "eduStartDate": "1-1-2014",
    "eduEndDate": "1-1-2018"
  },
  {
    "id": 2,
    "applicantId": 1,
    "eduSchool": "Cleveland State University",
    "eduDegree": "Bachelor of Science in Computer Engineering",
    "eduDescription": "Computer Engineering combines Electrical Engineering and Computer Science and deals with the design and application of computer systems. These computer systems can range from large super computers to tiny microprocessors that are embedded in all kinds of equipment, such as automobiles, appliances, cellular phones, medical devices, office equipment, etc. The goal of the Computer Engineering program at SFSU is to provide students with a practical, hands-on education that emphasizes applications.",
    "eduStartDate": "1-1-2019",
    "eduEndDate": "1-1-2023"
  }
]

404 (Not Found)

A 404 (Not Found) response has two possible outcomes one if the user profile doesn't have any education or if the provided user doesn't have a profile, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, this profile doesn't have education yet"
}


{
  "message": "Oops, doesn't look like that profile exists"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while fetching this education"
}

ADD EDUCATION

Add education for a applicant profile by user id

Method Url: /api/education

HTTP method: [POST]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Body

name	type	required	description
`userId`	Integer	Yes	Must match a user's id in the database
`eduSchool`	String	Yes	Cannot be an empty field
`eduDegree`	String	Yes	Cannot be an empty field
`eduDescription`	String	Yes	Cannot be an empty field
`eduStartDate`	String	Yes	Cannot be an empty field
`eduEndDate`	String	Yes	Cannot be an empty field

example:


{
  "userId": 1,
  "applicantEducation": [
    {
      "eduSchool":"Cleveland State University",
      "eduDegree": "Bachelor of Science in Computer Engineering",
      "eduDescription": "Computer Engineering combines Electrical Engineering and Computer Science and deals with the design and application of computer systems. These computer systems can range from large super computers to tiny microprocessors that are embedded in all kinds of equipment, such as automobiles, appliances, cellular phones, medical devices, office equipment, etc. The goal of the Computer Engineering program at SFSU is to provide students with a practical, hands-on education that emphasizes applications.",
      "eduStart":"1-1-2019",
      "eduEnd": "1-1-2023"
    },
    {
      "eduSchool":"Cleveland State University",
      "eduDegree": "Bachelor of Science in Electrical Engineering",
      "eduDescription": "Electrical Engineering is a profession that makes creative use of mathematics and science to solve practical problems in electricity, electronics and related areas. The goal of the Electrical Engineering program at SFSU is to provide students with a practical, hands-on education that emphasizes applications.",
      "eduStart":"1-1-2014",
      "eduEnd": "1-1-2018"
    }
  ]
}

Response

201 (Created)

If you successfully create applicant education, the endpoint will return an HTTP response with a status code 201 and a body as below.

example:


[
  {
    "id": 1,
    "applicantId": 1,
    "eduSchool": "Cleveland State University",
    "eduDegree": "Bachelor of Science in Computer Engineering",
    "eduDescription": "Computer Engineering combines Electrical Engineering and Computer Science and deals with the design and application of computer systems. These computer systems can range from large super computers to tiny microprocessors that are embedded in all kinds of equipment, such as automobiles, appliances, cellular phones, medical devices, office equipment, etc. The goal of the Computer Engineering program at SFSU is to provide students with a practical, hands-on education that emphasizes applications.",
    "eduStart": "1-1-2019",
    "eduEnd": "1-1-2023"
  },
  {
    "id": 2,
    "applicantId": 1,
    "eduSchool": "Cleveland State University",
    "eduDegree": "Bachelor of Science in Electrical Engineering",
    "eduDescription": "Electrical Engineering is a profession that makes creative use of mathematics and science to solve practical problems in electricity, electronics and related areas. The goal of the Electrical Engineering program at SFSU is to provide students with a practical, hands-on education that emphasizes applications.",
    "eduStart": "1-1-2014",
    "eduEnd": "1-1-2018"
  }
]

404 (Not Found)

If the applicant profile for the specified userId can't be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, that user profile doesn't exist"
}

400 (Bad Request)

If you are missing any of the required field(s), the endpoint will return an HTTP response with a status code 400 and a body as below relating to the missing field(s).

example:


{
  "message": "Please provide a school"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Sorry, but something went wrong while trying to add education"
}

UPDATE EDUCATION

Update individual education objects using education id

Method Url: /api/education/:id

HTTP method: [PUT]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific education object

Body

name	type	required	description
`eduSchool`	String	Yes	Cannot be an empty field
`eduDegree`	String	Yes	Cannot be an empty field
`eduDescription`	String	Yes	Cannot be an empty field
`eduStartDate`	String	Yes	Cannot be an empty field
`eduEndDate`	String	Yes	Cannot be an empty field

example:


{
  "eduSchool": "Cleveland State University Updated",
  "eduDegree": "Bachelor of Science in Computer Engineering",
  "eduDescription": "Computer Engineering combines Electrical Engineering and Computer Science and deals with the design and application of computer systems. These computer systems can range from large super computers to tiny microprocessors that are embedded in all kinds of equipment, such as automobiles, appliances, cellular phones, medical devices, office equipment, etc. The goal of the Computer Engineering program at SFSU is to provide students with a practical, hands-on education that emphasizes applications.",
  "eduStartDate": "1-1-2019",
  "eduEndDate": "1-1-2023"
}

Response

200 (OK)

If the education object with the specified ID in the URL parameters is updated successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "id": 53,
  "applicantId": 23,
  "eduSchool": "Cleveland State University Updated",
  "eduDegree": "Bachelor of Science in Computer Engineering",
  "eduDescription": "Computer Engineering combines Electrical Engineering and Computer Science and deals with the design and application of computer systems. These computer systems can range from large super computers to tiny microprocessors that are embedded in all kinds of equipment, such as automobiles, appliances, cellular phones, medical devices, office equipment, etc. The goal of the Computer Engineering program at SFSU is to provide students with a practical, hands-on education that emphasizes applications.",
  "eduStartDate": "1-1-2019",
  "eduEndDate": "1-1-2023"
}

404 (Not Found)

If the education object for the specified id can't be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like that profile exists"
}

400 (Bad Request)

If you are missing any of the required field(s), the endpoint will return an HTTP response with a status code 400 and a body as below relating to the missing field(s).

example:


{
  "message": "Please provide a school"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while updating this education"
}

DELETE EDUCATION

Delete education by education id

Method Url: /api/education/:id

HTTP method: [DELETE]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of education object

Response

200 (OK)

If the education object specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "message": "Education successfully deleted"
}

404 (Not Found)

If the education object specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like this education exists"
}

500 (Bad Request)

If you send in invalid fields, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while deleting this education"
}

EXPERIENCE ROUTES

GET EXPERIENCE

Get experience by user id

Method Url: /api/experience/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Response

200 (OK)

If applicant experience is found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


[
  {
    "id": 1,
    "applicantId": 1,
    "expTitle": "Front-end Developer",
    "expCompany": "Facebook",
    "expDescription": "Built out facebook market place with react",
    "expStartDate": "1-25-2018",
    "expEndDate": "9-2-2019"
  },
  {
    "id": 2,
    "applicantId": 1,
    "expTitle": "Back-end Developer",
    "expCompany": "Nexient",
    "expDescription": "Created apis and servers with golang",
    "expStartDate": "10-31-2019",
    "expEndDate": "6-31-2020"
  }
]

404 (Not Found)

A 404 (Not Found) response has two possible outcomes one if the user profile doesn't have any education or if the provided user doesn't have a profile, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like that profile exists"
}


{
  "message": "Oops, this profile doesn't have experience yet"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while fetching this experience"
}

ADD EXPERIENCE

Add experience by user id

Method Url: /api/experience

HTTP method: [POST]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Body

name	type	required	description
`userId`	Integer	Yes	Must match a user's id in the database
`expTitle`	String	Yes	Cannot be an empty field
`expCompany`	String	Yes	Cannot be an empty field
`expDescription`	String	Yes	Cannot be an empty field
`expStartDate`	String	Yes	Cannot be an empty field
`expEndDate`	String	Yes	Cannot be an empty field

example:


{
  "userId":1,
  "applicantExperience": [
    {
      "expTitle":"Back-end Developer",
      "expCompany": "Nexient",
      "expDescription": "Created apis and servers with golang",
      "expStartDate": "10-31-2019",
      "expEndDate": "6-31-2020"
    },
    {
      "expTitle":"Front-end Developer",
      "expCompany": "Facebook",
      "expDescription": "Built out facebook market place with react",
      "expStartDate": "1-25-2018",
      "expEndDate": "9-2-2019"
    }
  ]
}

Response

201 (Created)

If you successfully create applicant experience, the endpoint will return an HTTP response with a status code 201 and a body as below.

example:


[
  {
    "id": 1,
    "applicantId": 1,
    "expTitle": "Back-end Developer",
    "expCompany": "Nexient",
    "expDescription": "Created apis and servers with golang",
    "expStartDate": "10-31-2019",
    "expEndDate": "6-31-2020"
  },
  {
    "id": 2,
    "applicantId": 1,
    "expTitle": "Front-end Developer",
    "expCompany": "Facebook",
    "expDescription": "Built out facebook market place with react",
    "expStartDate": "1-25-2018",
    "expEndDate": "9-2-2019"
  }
]

404 (Not Found)

If the applicant profile for the specified userId can't be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, that user profile doesn't exist"
}

400 (Bad Request)

If you are missing any of the required field(s), the endpoint will return an HTTP response with a status code 400 and a body as below relating to the missing field(s).

example:


{
  "message": "Please provide a job title"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while trying to add experience"
}

UPDATE EXPERIENCE

Update individual experience objects using experience id

Method Url: /api/experience/:id

HTTP method: [PUT]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific education object

Body

name	type	required	description
`expTitle`	String	Yes	Cannot be an empty field
`expCompany`	String	Yes	Cannot be an empty field
`expDescription`	String	Yes	Cannot be an empty field
`expStartDate`	String	Yes	Cannot be an empty field
`expEndDate`	String	Yes	Cannot be an empty field

example:


{
  "expTitle":"Front-end Developer Updated",
  "expCompany": "Facebook",
  "expDescription": "Built out facebook market place with react",
  "expStartDate": "1-25-2018",
  "expEndDate": "9-2-2019"
}

Response

200 (OK)

If the experience object with the specified ID in the URL parameters is updated successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "id": 21,
  "applicantId": 23,
  "expTitle": "Front-end Developer Updated",
  "expCompany": "Facebook",
  "expDescription": "Built out facebook market place with react",
  "expStartDate": "1-25-2018",
  "expEndDate": "9-2-2019"
}

404 (Not Found)

If the education object for the specified id can't be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like that profile exists"
}

400 (Bad Request)

If you are missing any of the required field(s), the endpoint will return an HTTP response with a status code 400 and a body as below relating to the missing field(s).

example:


{
  "message": "Please provide a job title"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while updating this experience"
}

DELETE EXPERIENCE

Delete experience by experience id

Method Url: /api/experience/:id

HTTP method: [DELETE]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of experience object

Response

200 (OK)

If the experience object specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "message": "Experience successfully deleted"
}

404 (Not Found)

If the experience object specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like this experience exists"
}

500 (Bad Request)

If you send in invalid fields, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while deleting this experience"
}

APPLICANTSKILLS ROUTES

GET APPLICANTSKILLS

Get applicantSkills by user id

Method Url: /api/applicant-skills/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Response

200 (OK)

If applicant skills are found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


[
  {
    "id": 1,
    "applicantId": 1,
    "applicantSkill": "Express"
  },
  {
    "id": 2,
    "applicantId": 1,
    "applicantSkill": "Node"
  },
  {
    "id": 3,
    "applicantId": 1,
    "applicantSkill": "React"
  }
]

404 (Not Found)

A 404 (Not Found) response has two possible outcomes one if the user profile doesn't have any education or if the provided user doesn't have a profile, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like that profile exists"
}


{
  "message": "Oops, that profile doesn't have any skills"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while fetching this profile"
}

ADD APPLICANTSKILLS

Add applicantskills by user id

Method Url: /api/applicant-skills

HTTP method: [POST]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Body

name	type	required	description
`applicantId`	Integer	Yes	Must match a applicant's id in the database
`applicantSkills`	String	Yes	(Array of strings) Cannot be an empty field

example:


{
  "skills": {
    "applicantId": 2,
    "applicantSkills": ["Express", "Node", "React"]
  }
}

Response

201 (Created)

If you successfully create applicant skills, the endpoint will return an HTTP response with a status code 201 and a body as below.

example:


[
  {
    "id": 1,
    "applicantId": 1,
    "applicantSkill": "Express"
  },
  {
    "id": 2,
    "applicantId": 1,
    "applicantSkill": "Node"
  },
  {
    "id": 3,
    "applicantId": 1,
    "applicantSkill": "React"
  }
]

404 (Not Found)

If the applicant profile for the specified userId can't be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Sorry, but that user doesn't have a profile"
}

400 (Bad Request)

If you are missing any of the required field(s), the endpoint will return an HTTP response with a status code 400 and a body as below relating to the missing field(s).

example:


{
  "message": "Please provide some skills"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while creating your skill"
}

UPDATE SKILL

Update skill by skill id

Method Url: /api/applicant-skills/:id

HTTP method: [PUT]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific skill object

Body

name	type	required	description
`applicantSkill`	String	Yes	Cannot be an empty field

example:


{
  "applicantSkill": "Python"
}

Response

200 (OK)

If the skill object with the specified ID in the URL parameters is updated successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "id": 1,
  "applicantId": 1,
  "applicantSkill": "Python"
}

404 (Not Found)

If the education object for the specified id can't be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like that skill exists"
}

400 (Bad Request)

If you are missing any of the required field(s), the endpoint will return an HTTP response with a status code 400 and a body as below relating to the missing field(s).

example:


{
  "message": "Please provide a skill"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while updating this skill"
}

DELETE SKILL

Delete APPLICANTSKILLS by skill id

Method Url: /api/applicant-skill/:id

HTTP method: [DELETE]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of skill object

Response

200 (OK)

If the skill object specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
  "message": "Skill successfully deleted"
}

404 (Not Found)

If the skill object specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Oops, doesn't look like that skill exists"
}

500 (Bad Request)

If you send in invalid fields, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while deleting this skill"
}

COMPANY ROUTES

GET COMPANIES

Get all companies

Method Url: /api/companies

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Response

200 (OK)

If companies are found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.


{
  "companies": [
    {
      "id": 1,
      "userId": 1,
      "companyName": "Apple",
      "companyDescription": "An About me for the company",
      "country": "South Korea",
      "state": "NA",
      "city": "Seoul",
      "zipcode": 4000,
      "address": "123 abc st"
    },
    {
      "id": 2,
      "userId": 2,
      "companyName": "Apple 2",
      "companyDescription": "An About me for the company",
      "country": "South Korea",
      "state": "NA",
      "city": "Seoul",
      "zipcode": 4000,
      "address": "123 abc st"
    }
  ]
}

404 (Not Found)

If there are no companies in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.


{
  "message": "Oops, doesn't look like there are any companies"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.


{
  message: 'Oops, something went wrong while fetching this profile'
}

GET COMPANY

Get a company by ID

Method Url: /api/companies/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific company

Response

200 (OK)

If a company with the specified ID in the URL parameters is found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.


{
  "company": {
    "id": 1,
    "userId": 1,
    "companyName": "Apple 2",
    "companyDescription": "An About me for the company",
    "country": "South Korea",
    "state": "NA",
    "city": "Seoul",
    "zipcode": 4000,
    "address": "123 Abc st"
    "jobs": [
      {
        "id": 1,
        "companyId": 1,
        "jobName": "Software Engineer",
        "jobDescription": "An About me for the job",
        "jobExperienceRequired": "jobExperienceRequired",
        "jobExperiencePreferred": "jobExperiencePreferred",
        "jobResponsibilities": "jobResponsibilities",
        "jobApplyBy": "jobApplyBy",
        "jobSkills": [
            {
              "id": 1,
              "jobId": 1,
              "jobSkill": "Reactjs"
            },
            {
              "id": 3,
              "jobId": 1,
              "jobSkill": "Expressjs updated"
            }
          ]
        },
        {
        "id": 2,
        "companyId": 1,
        "jobName": "Front-end Engineer",
        "jobDescription": "An About me for the job",
        "jobExperienceRequired": "jobExperienceRequired",
        "jobExperiencePreferred": "jobExperiencePreferred",
        "jobResponsibilities": "jobResponsibilities",
        "jobApplyBy": "jobApplyBy",
        "jobSkills": []
      }
    ]
  }
}

404 (Not Found)

If the requested company does not exist, the endpoint will return an HTTP response with a status code 404 and a body as below.


{
  "message": "Oops, doesn't look like there are any companies"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.


{
  message: 'Oops, something went wrong while fetching this profile'
}

ADD COMPANY

Add a Company

Method Url: /api/companies

HTTP method: [POST]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Body

name	type	required	description
`userId`	Integer	Yes	Must match a user's id in the database
`companyName`	String	Yes	Cannot be an empty field
`companyDescription`	String	Yes	Cannot be an empty field
`country`	String	Yes	Cannot be an empty field
`state`	String	Yes	Cannot be an empty field
`city`	String	Yes	Cannot be an empty field
`zipcode`	Integer	Yes	Cannot be an empty field
`address`	String	Yes	Cannot be an empty field

example:

{
  "userId": 1,
  "companies": {
    "companyName": "Apple",
    "companyDescription": "An About me for the company",
    "country": "United States of America",
    "state": "California",
    "city": "Cupertino",
    "zipcode": 4000,
    "address": "123 Abc st"
  }
}

Response

201 (Created)

If you successfully register a company the endpoint will return an HTTP response with a status code 201 and a body as below.

{
  "message": "Apple has been successfully added.",
  "companies": {
  	"id": 1,
    "companyName": "Apple",
    "companyDescription": "An About me for the company",
    "country": "United States of America",
    "state": "California",
    "city": "Cupertino",
    "zipcode": 4000,
    "address": "123 Abc st"
  }
}

400 (Bad Request)

If you are missing any of the required fields, the endpoint will return an HTTP response with a status code 400 and a body as below.


{
  message: 'Please submit a company with all of the required fields.'
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.


{
  message: 'Oops, something went wrong while creating your profile'
}

UPDATE COMPANY

Update a Company by user ID

Method Url: /api/companies/:id

HTTP method: [PUT]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific company

Body

name	type	required	description
`userId`	Integer	Yes	Must match a user's id in the database
`companyName`	String	Yes	Cannot be an empty field
`companyPicture`	String	No	Can be an empty field
`companyDescription`	String	Yes	Cannot be an empty field
`country`	String	Yes	Cannot be an empty field
`state`	String	Yes	Cannot be an empty field
`city`	String	Yes	Cannot be an empty field
`zipcode`	Integer	Yes	Cannot be an empty field
`address`	String	Yes	Cannot be an empty field

example:


{
  "userId": 1,
  "companyName": "Apple Inc",
  "companyPicture": "url string",
  "companyDescription": "An About me for the company",
  "country": "United States of America",
  "state": "California",
  "city": "Cupertino",
  "zipcode": "40000",
  "address": "123 Abc st"
}

Response

200 (OK)

If a company with the specified ID in the URL parameters is updated successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.


{
  "id": 1,
  "userId": 1,
  "companyName": "Apple Inc",
  "companyPicture": "",
  "companyDescription": "An About me for the company",
  "country": "South Korea",
  "state": "NA",
  "city": "Seoul",
  "zipcode": 4000,
  "address": "123 Abc st"
}

400 (Not Acceptable)

If you are missing any of the required fields, the endpoint will return an HTTP response with a status code 400 and a body as below.


{
  message: 'Please submit a company with all of the required fields.'
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.


{
  message: 'Oops, something went wrong while updating this company'
}

DELETE COMPANY

Delete a Company by user ID

Method Url: /api/companies/:id

HTTP method: [DELETE]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific company

Response

200 (OK)

If a company with the specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.


{
  "message": "Company successfully deleted"
}

404 (Not Found)

If no companies for the specified id can be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.


{
  "message": 'Oops, doesn't look like that company exists'
}

500 (Bad Request)

If you send in invalid fields, the endpoint will return an HTTP response with a status code 500 and a body as below.


{
  "message": "Oops, something went wrong while deleting this company"
}

JOB ROUTES

GET JOBS

Get all jobs

Method Url: /api/jobs

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Response

200 (OK)

If jobs are found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

{
  "jobs": [
    {
      "id": 1,
      "companyId": 1,
      "jobName": "Software Engineer",
      "jobDescription": "An About me for the job",
      "jobExperienceRequired": "jobExperienceRequired",
      "jobExperiencePreferred": "jobExperiencePreferred",
      "jobApplyBy": "jobApplyBy",
      "jobSkills": [...]
    },
    {
      "id": 2,
      "companyId": 1,
      "jobName": "Front-end Engineer",
      "jobDescription": "An About me for the job",
      "jobExperienceRequired": "jobExperienceRequired",
      "jobExperiencePreferred": "jobExperiencePreferred",
      "jobApplyBy": "jobApplyBy",
      "jobSkills": [...]
    },
    {
      "id": 4,
      "companyId": 1,
      "jobName": "Back-end Engineer 4",
      "jobDescription": "An About me for the job",
      "jobExperienceRequired": "jobExperienceRequired",
      "jobExperiencePreferred": "jobExperiencePreferred",
      "jobApplyBy": "jobApplyBy",
      "jobSkills": [...]
    }
  ]
}

404 (Not Found)

If there are no jobs in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.


{
  "message": "Oops, could not retrieve the job"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.


{
  message: 'Oops, something went wrong while fetching jobs'
}

GET JOB

Get a job by ID

Method Url: /api/jobs/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific job

Response

200 (OK)

If a job with the specified ID in the URL parameters is found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

{
    "jobs": {
        "id": 1,
        "companyId": 1,
        "jobName": "Frontend Software Engineer",
        "jobDescription": "Are you excited by the prospect of creating simple, intuitive experiences that delight users? Do you like building services that will be used by hundreds of millions of users across the world? Microsoft Developer Center Norway is growing, and we’re looking for developers with a strong passion for building delightful and smart experiences that will be used on a global scale. Come join our team!",
        "jobExperienceRequired": "<ul><li>Masters or Bachelor’s degree or equivalent in computer science or related technical disciplines.</li><li>Experience with software engineering best practices (code quality, repo hygiene, code reviews, unit testing, design documentation, continuous integration, deployment).</li><li>Experience in the JavaScript ecosystem and related technologies such as React, React Native, TypeScript, Redux, HTML5, CSS.</li></ul>",
        "jobExperiencePreferred": "<ul><li>Experience in building performant experiences using technologies such as webpack and npm to optimize bundles and package dependencies.</li><li>Experience in experimentation framework and understanding how to measure end user success.</li><li>Thrives in dynamic, fast-paced environments where passion for customer engagement and great experience are at the forefront of all design & development.</li></ul>",
        "jobApplyBy": "30 May 2019"
    }
}

404 (Not Found)

If the requested job does not exist, the endpoint will return an HTTP response with a status code 404 and a body as below.

{
  "message": "Oops, could not retrieve the job"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

{
  message: 'Oops, something went wrong while fetching jobs'
}

ADD JOB

Add a job

Method Url: /api/jobs

HTTP method: [POST]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Body

name	type	required	description
`companyId`	Integer	Yes	Must match a company's id in the database
`jobName`	String	Yes	Cannot be an empty field
`jobDescription`	String	Yes	Cannot be an empty field
`jobExperienceRequired`	String	Yes	Cannot be an empty field
`jobExperiencePreferred`	String	Yes	Cannot be an empty field
`jobApplyBy`	String	Yes	Cannot be an empty field

example:

{
    "userId": 1,
    "job": {
        "jobName": "Back-end Engineer 11",
        "jobDescription": "An About me for the job",
        "jobExperienceRequired": "jobExperienceRequired",
        "jobExperiencePreferred": "jobExperiencePreferred",
        "jobApplyBy": "jobApplyBy"
    },
    "jobSkills": [
        "Skill4",
        "Skill5"
    ]
}

Response

201 (Created)

If you successfully register a job the endpoint will return an HTTP response with a status code 201 and a body as below.


{
  "message": "Back-end Engineer 11 has successfully been added.",
  "newJob": {
    "companyId": 10,
    "jobName": "Back-end Engineer 11",
    "jobDescription": "An About me for the job",
    "jobExperienceRequired": "jobExperienceRequired",
    "jobExperiencePreferred": "jobExperiencePreferred",
    "jobApplyBy": "jobApplyBy",
    "jobSkills": [
      "Skill4",
      "Skill5"
    ]
  }
}

400 (Bad Request)

If you are missing any of the required fields, the endpoint will return an HTTP response with a status code 400 and a body as below.


{
  message: 'Please submit a job with all of the required fields.'
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.


{
  message: 'Oops, something went wrong while fetching jobs'
}

UPDATE JOB

Update a Job by company ID

Method Url: /api/jobs/:id

HTTP method: [PUT]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific job

Body

name	type	required	description
`companyId`	Integer	Yes	Must match a user's id in the database
`jobName`	String	Yes	Cannot be an empty field
`jobDescription`	String	Yes	Cannot be an empty field
`jobExperienceRequired`	String	Yes	Cannot be an empty field
`jobExperiencePreferred`	String	Yes	Cannot be an empty field
`jobApplyBy`	String	Yes	Cannot be an empty field

example:

{
  "companyId": 1,
  "jobName": "Back-end Engineer updated",
  "jobDescription": "An About me for the job",
  "jobExperienceRequired": "jobExperienceRequired",
  "jobExperiencePreferred": "jobExperiencePreferred",
  "jobApplyBy": "jobApplyBy"
}

Response

200 (OK)

If a job with the specified ID in the URL parameters is updated successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

{
  "message": "The job was updated successfully",
  "jobs": {
    "id": 2,
    "companyId": 1,
    "jobName": "Back-end Engineer updated",
    "jobDescription": "An About me for the job",
    "jobExperienceRequired": "jobExperienceRequired",
    "jobExperiencePreferred": "jobExperiencePreferred",
    "jobApplyBy": "jobApplyBy"
}

400 (Not Acceptable)

If you are missing any of the required fields, the endpoint will return an HTTP response with a status code 400 and a body as below.

{
  message: 'Oops, could not find job in the database'
}

404 (Not Found)

If the requested job does not exist, the endpoint will return an HTTP response with a status code 404 and a body as below.

{
  "message": "Oops, something went wrong while fetching jobs"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

{
  message: 'Oops, something went wrong while fetching jobs'
}

DELETE JOB

Delete a Job by company ID

Method Url: /api/jobs/:id

HTTP method: [DELETE]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific job

Response

200 (OK)

If a job with the specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.


{
  "message": "Job was deleted successfully"
}

404 (Not Found)

If no companies for the specified id can be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

{
  "message": 'Oops, job could not be found'
}

500 (Bad Request)

If you send in invalid fields, the endpoint will return an HTTP response with a status code 500 and a body as below.

{
  "message": "Oops, something went wrong while fetching jobs"
}

JOB SKILLS ROUTES

GET JOB SKILLS

Get all job skills

Method Url: /api/job-skills

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Response

200 (OK)

If jobs are found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

{
  "skills": [
    {
      "id": 1,
      "jobId": 1,
      "jobSkill": "Reactjs"
    },
    {
      "id": 3,
      "jobId": 1,
      "jobSkill": "Expressjs"
    }
  ]
}

404 (Not Found)

If there are no jobs in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

{
  "message": "Oops, the job skill could not be found"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

{
  message: 'Oops, something went wrong fetching job skills'
}

GET JOB SKILL

Get a job skill by ID

Method Url: /api/job-skills/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific job skill

Response

200 (OK)

If a job with the specified ID in the URL parameters is found in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

{
  "message": "The job skill was retrieved successfully.",
  "skills": {
    "id": 1,
    "jobId": 1,
    "jobSkill": "Reactjs"
  }
}

404 (Not Found)

If the requested job does not exist, the endpoint will return an HTTP response with a status code 404 and a body as below.

{
  "message": "Oops, that job skill could not be found"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

{
  message: 'Oops, something went wrong fetching job skills'
}

ADD JOB SKILL

Add a job skill

Method Url: /api/job-skills

HTTP method: [POST]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Body

name	type	required	description
`jobId`	Integer	Yes	Must match a company's id in the database
`jobSkill`	Array of strings	Yes	Cannot be an empty field

example:

{
  "jobId": 1,
  "jobSkill": ["Reactjs", "Expressjs"]
}

Response

201 (Created)

If you successfully register a job, the endpoint will return an HTTP response with a status code 201 and a body as below (returns all job skills for the jobId, not just the created jobs).

{
  "message": "Reactjs,Expressjs has successfully been added.",
  "skills": [
    {
      "id": 1,
      "jobId": 1,
      "jobSkill": "Reactjs"
    },
    {
      "id": 3,
      "jobId": 1,
      "jobSkill": "Expressjs updated"
    },
    {
      "id": 16,
      "jobId": 1,
      "jobSkill": "Reactjs"
    },
    {
      "id": 17,
      "jobId": 1,
      "jobSkill": "Expressjs"
    }
  ]
}

400 (Bad Request)

If you are missing any of the required fields, the endpoint will return an HTTP response with a status code 400 and a body as below.

{
  message: 'Oops, that job skill could not be found'
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

{
  message: 'Oops, something went wrong updating job skills'
}

UPDATE JOB SKILL

Update a Job Skill by company ID

Method Url: /api/job-skills/:id

HTTP method: [PUT]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific job skill

Body

name	type	required	description
`jobSkill`	String	Yes	Cannot be an empty field

example:

{
  "jobSkill": "This was updated 2"
}

Response

200 (OK)

If a job with the specified ID in the URL parameters is updated successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

{
  "id": 1,
  "jobId": 1,
  "jobSkill": "This was updated 2"
}

404 (Not Acceptable)

If you are missing any of the required fields, the endpoint will return an HTTP response with a status code 404 and a body as below.

{
  message: 'Please submit a job with all of the required fields.'
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

{
  message: 'Oops, something went wrong updating job skills'
}

DELETE JOB SKILL

Delete a Job Skill by company ID

Method Url: /api/job-skills/:id

HTTP method: [DELETE]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	ID of a specific job skill

Response

200 (OK)

If a job with the specified ID in the URL parameters is deleted successfully in the database, the endpoint will return an HTTP response with a status code 200 and a body as below.

{
  "message": "Success, job skill deleted"
}

404 (Not Found)

If no companies for the specified id can be found in the database, the endpoint will return an HTTP response with a status code 404 and a body as below.

{
  "message": 'Oops, skill could not be found'
}

500 (Bad Request)

If you send in invalid fields, the endpoint will return an HTTP response with a status code 500 and a body as below.

{
  "message": "Oops, something went wrong deleting job skills"
}

MATCH ROUTES

GET MATCHES

Get matches for applicant

Method Url: /api/matches/applicant/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	applicant id

Response

200 (OK)

If there are recommended matches, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:

[
    {
        "id": 1,
        "companyId": 1,
        "jobName": "Frontend Software Engineer",
        "jobDescription": "Are you excited by the prospect of creating simple, intuitive experiences that delight users? Do you like building services that will be used by hundreds of millions of users across the world? Microsoft Developer Center Norway is growing, and we’re looking for developers with a strong passion for building delightful and smart experiences that will be used on a global scale. Come join our team!",
        "jobExperienceRequired": "<ul><li>Masters or Bachelor’s degree or equivalent in computer science or related technical disciplines.</li><li>Experience with software engineering best practices (code quality, repo hygiene, code reviews, unit testing, design documentation, continuous integration, deployment).</li><li>Experience in the JavaScript ecosystem and related technologies such as React, React Native, TypeScript, Redux, HTML5, CSS.</li></ul>",
        "jobExperiencePreferred": "<ul><li>Experience in building performant experiences using technologies such as webpack and npm to optimize bundles and package dependencies.</li><li>Experience in experimentation framework and understanding how to measure end user success.</li><li>Thrives in dynamic, fast-paced environments where passion for customer engagement and great experience are at the forefront of all design & development.</li></ul>",
        "jobApplyBy": "30 May 2019",
        "jobSkills": [
            {
                "id": 1,
                "jobId": 1,
                "jobSkill": "React"
            },
            {
                "id": 2,
                "jobId": 1,
                "jobSkill": "HTML"
            },
            {
                "id": 3,
                "jobId": 1,
                "jobSkill": "CSS"
            },
            {
                "id": 4,
                "jobId": 1,
                "jobSkill": "Bootstrap"
            },
            {
                "id": 5,
                "jobId": 1,
                "jobSkill": "Git"
            }
        ],
        "count": 4
    },
    {
        "id": 2,
        "companyId": 2,
        "jobName": "Frontend Software Engineer",
        "jobDescription": "As a Front End Engineer you will be responsible for building the next generation of client side user experiences for our industry leading Music Subscription service. We are a team that conceptualizes, iterates, and executes new features on an ongoing basis, which contributes to an overall dynamic and creative atmosphere.We need a highly motivated and skillful engineer with JavaScript programming proficiency, plus a solid grasp of the performance and compatibility issues that arise when delivering a comprehensive web solution. Attention to detail and a dedication to deliver a high-quality, stable delivery is essential. To be successful you are self-motivated; driven to achieve and exceed commitments. You also need to exude strong collaboration skills, including the ability to mentor and be mentored. Possess a strong passion to work in a growing, energizing environment of innovation. If you want to be part of this amazing team, this position is for you.",
        "jobExperienceRequired": "<ul><li>Proficient JavaScript programmer</li><li>Experience with JS frameworks is highly desirable: React, Angular, etc.</li><li>Experience with CSS3 and Less/Sass in large scale applications</li></ul>",
        "jobExperiencePreferred": "<ul><li>Knowledge of media streaming, HTML5 MSE/EME, encryption standards a plus</li><li>Strong problem solving and critical thinking skills</li><li>Passion for quality and close attention to details</li></ul>",
        "jobApplyBy": "30 May 2019",
        "jobSkills": [
            {
                "id": 6,
                "jobId": 2,
                "jobSkill": "React"
            },
            {
                "id": 7,
                "jobId": 2,
                "jobSkill": "jQuery"
            },
            {
                "id": 8,
                "jobId": 2,
                "jobSkill": "HTML"
            },
            {
                "id": 9,
                "jobId": 2,
                "jobSkill": "CSS"
            },
            {
                "id": 10,
                "jobId": 2,
                "jobSkill": "Git"
            }
        ],
        "count": 4
    }
]

404 (Not Found)

If the provided userId doesn't have a profile, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
   "message": "Oops, the user doesn't have a profile"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while fetching matches"
}

Get matches for company for all jobs

Method Url: /api/matches/company/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	company id

Response

200 (OK)

If there are recommended matches, the endpoint will return an HTTP response with a status code 200 and a body as below. This will show a list of all profiles matched with all jobs for that company. Filter by jobId if you want to see it only for each job.

example:

[
    {
        "skills": [
            "Golang",
            "Python",
            "JavaScript",
            "Node",
            "Express",
            "C++",
            "C#",
            "MySQL",
            "PostgreSQL",
            "HTML",
            "Git",
            "React",
            "CSS",
            "Django",
            "Redux",
            "Webpack",
            "Git"
        ],
        "applicantId": 2,
        "jobId": 3,
        "count": 3,
        "profile": {
            "id": 2,
            "userId": 2,
            "firstName": "John",
            "lastName": "Dough",
            "profilePicture": "http://www.stleos.uq.edu.au/wp-content/uploads/2016/08/image-placeholder-350x350.png",
            "month": 5,
            "day": 21,
            "year": 1994,
            "country": "United States",
            "state": "Washington",
            "city": "Redmond",
            "zipcode": 98008
        }
    },
    {
        "skills": [
            "Java",
            "JavaScript",
            "Kafka",
            "jQuery",
            "HTML",
            "CSS",
            "Bootstrap",
            "Git"
        ],
        "applicantId": 1,
        "jobId": 3,
        "count": 2,
        "profile": {
            "id": 1,
            "userId": 1,
            "firstName": "Sam",
            "lastName": "Smith",
            "profilePicture": "http://www.stleos.uq.edu.au/wp-content/uploads/2016/08/image-placeholder-350x350.png",
            "month": 10,
            "day": 13,
            "year": 1990,
            "country": "United States",
            "state": "California",
            "city": "San Francisco",
            "zipcode": 94016
        }
    },
    {
        "skills": [
            "Java",
            "Spring Framework",
            "React",
            "MySQL",
            "PostgreSQL",
            "Ruby"
        ],
        "applicantId": 3,
        "jobId": 3,
        "count": 1,
        "profile": {
            "id": 3,
            "userId": 3,
            "firstName": "Sally",
            "lastName": "Jones",
            "profilePicture": "http://www.stleos.uq.edu.au/wp-content/uploads/2016/08/image-placeholder-350x350.png",
            "month": 1,
            "day": 2,
            "year": 1992,
            "country": "United States",
            "state": "Michigan",
            "city": "Detroit",
            "zipcode": 48127
        }
    }
]

404 (Not Found)

If the provided userId doesn't have a company, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
   "message": "Oops, the user doesn't have a profile"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, something went wrong while fetching matches"
}

GET MATCHED

Get matched jobs by user id

Method Url: /api/matched/applicant/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	user id

Response

200 (OK)

If the user has matched with any jobs, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:

[
    {
        "id": 1,
        "companyId": 1,
        "jobName": "Frontend Software Engineer",
        "jobDescription": "Are you excited by the prospect of creating simple, intuitive experiences that delight users? Do you like building services that will be used by hundreds of millions of users across the world? Microsoft Developer Center Norway is growing, and we’re looking for developers with a strong passion for building delightful and smart experiences that will be used on a global scale. Come join our team!",
        "jobExperienceRequired": "<ul><li>Masters or Bachelor’s degree or equivalent in computer science or related technical disciplines.</li><li>Experience with software engineering best practices (code quality, repo hygiene, code reviews, unit testing, design documentation, continuous integration, deployment).</li><li>Experience in the JavaScript ecosystem and related technologies such as React, React Native, TypeScript, Redux, HTML5, CSS.</li></ul>",
        "jobExperiencePreferred": "<ul><li>Experience in building performant experiences using technologies such as webpack and npm to optimize bundles and package dependencies.</li><li>Experience in experimentation framework and understanding how to measure end user success.</li><li>Thrives in dynamic, fast-paced environments where passion for customer engagement and great experience are at the forefront of all design & development.</li></ul>",
        "jobApplyBy": "30 May 2019"
    },
    {
        "id": 2,
        "companyId": 2,
        "jobName": "Frontend Software Engineer",
        "jobDescription": "As a Front End Engineer you will be responsible for building the next generation of client side user experiences for our industry leading Music Subscription service. We are a team that conceptualizes, iterates, and executes new features on an ongoing basis, which contributes to an overall dynamic and creative atmosphere.We need a highly motivated and skillful engineer with JavaScript programming proficiency, plus a solid grasp of the performance and compatibility issues that arise when delivering a comprehensive web solution. Attention to detail and a dedication to deliver a high-quality, stable delivery is essential. To be successful you are self-motivated; driven to achieve and exceed commitments. You also need to exude strong collaboration skills, including the ability to mentor and be mentored. Possess a strong passion to work in a growing, energizing environment of innovation. If you want to be part of this amazing team, this position is for you.",
        "jobExperienceRequired": "<ul><li>Proficient JavaScript programmer</li><li>Experience with JS frameworks is highly desirable: React, Angular, etc.</li><li>Experience with CSS3 and Less/Sass in large scale applications</li></ul>",
        "jobExperiencePreferred": "<ul><li>Knowledge of media streaming, HTML5 MSE/EME, encryption standards a plus</li><li>Strong problem solving and critical thinking skills</li><li>Passion for quality and close attention to details</li></ul>",
        "jobApplyBy": "30 May 2019"
    }
]

404 (Not Found)

If the provided userId doesn't have a profile, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Sorry, but that profile doesn't exist"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, there was an error getting the matches"
}

Get matched profiles by job id

Method Url: /api/matched/job/:id

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	job id

Response

200 (OK)

If the user has matched with any jobs, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:

[
    {
        "id": 2,
        "userId": 12,
        "firstName": "John",
        "lastName": "Dough",
        "profilePicture": "http://www.stleos.uq.edu.au/wp-content/uploads/2016/08/image-placeholder-350x350.png",
        "month": 5,
        "day": 21,
        "year": 1994,
        "country": "United States",
        "state": "Washington",
        "city": "Redmond",
        "zipcode": 98008
    },
    {
        "id": 1,
        "userId": 11,
        "firstName": "Sam",
        "lastName": "Smith",
        "profilePicture": "http://www.stleos.uq.edu.au/wp-content/uploads/2016/08/image-placeholder-350x350.png",
        "month": 10,
        "day": 13,
        "year": 1990,
        "country": "United States",
        "state": "California",
        "city": "San Francisco",
        "zipcode": 94016
    }
]

404 (Not Found)

If the provided jobId doesn't exist, the endpoint will return an HTTP response with a status code 404 and a body as below.

example:


{
  "message": "Sorry, but that job doesn't exist"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:


{
  "message": "Oops, there was an error getting the matches"
}

ADD MATCH

Add a applicant match for job

Method Url: /api/matches/applicant/:id/match/job/:jobId

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	user id
jobId	Integer	Yes	job id

Response

200 (OK)

If you successfully create a applicant profile, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:

{
    "message": "applicant has sent a match request successfully.",
    "match": [
        7
    ]
}

404 (Not found)

If the user Id or Job Id cannot find a profile then 404 and a body as below relating to the missing field(s).

example:

{
    "message": "Oops, the user doesn't have a profile"
}

{
    "message": "Oops, the job doesn't have a profile"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:

{
			message: 'Oops, something went wrong while fetching matches'
}

Add a job match for applicant

Method Url: /api/matches/job/:id/match/applicant/:applicantId

HTTP method: [GET]

Headers

name	type	required	description
`Content-Type`	String	Yes	Must be application/json
`Authorization`	String	Yes	JSON Web Token

Parameters

name	type	required	description
id	Integer	Yes	job id
applicantId	Integer	Yes	applicant id

Response

200 (OK)

If you successfully create a applicant profile, the endpoint will return an HTTP response with a status code 200 and a body as below.

example:


{
    "match": 1
}

404 (Not found)

If the user Id or Job Id cannot find a profile then 404 and a body as below relating to the missing field(s).

example:

{
    "message": "Oops, the user doesn't have a profile"
}

{
    "message": "Oops, the job doesn't have a profile"
}

500 (Internal Server Error)

If there is a server or database error, the endpoint will return an HTTP response with a status code 500 and a body as below.

example:

{
			message: 'Oops, something went wrong while fetching matches'
}

hyetigran / droom Goto Github PK

droom's Introduction

Droom API

Deployed Backend

Production

Developer

Setup

Table of Contents

Test User Accounts

Job Applicant Accounts

Arshak Smith

Tigran Dough

Gene Jones

Company Accounts

Microsoft

Apple

Github

SUMMARY TABLE OF API ENDPOINTS

AUTH ROUTES

REGISTER

Registers a user

Headers

Body

Response

201 (Created)

400 (Bad Request)

500 (Internal Server Error)

LOGIN

Logs a user in

Headers

Body

Response

200 (OK)

401 (Unauthorized)

500 (Bad Request)

APPLICANT ROUTES

GET APPLICANT

Get applicant profile by user id

Headers

Response

200 (OK)

404 (Not Found)

500 (Internal Server Error)

ADD applicant

Add an applicant

Headers

Body

Response

201 (Created)

500 (Internal Server Error)

UPDATE APPLICANT

Update a applicant by user id

Headers

Parameters

Body

Response

200 (OK)

404 (Not Found)

500 (Internal Server Error)

DELETE APPLICANT

Delete a applicant by user id

Headers

Parameters

Response

200 (OK)

404 (Not Found)

500 (Bad Request)

EDUCATION ROUTES

GET EDUCATION

Get education by user id

Headers

Response

200 (OK)

404 (Not Found)

500 (Internal Server Error)

ADD EDUCATION

Add education for a applicant profile by user id

Headers

Body

Response