Skip to content

Latest commit

 

History

History
63 lines (52 loc) · 3.1 KB

README.md

File metadata and controls

63 lines (52 loc) · 3.1 KB

JobQuest

JobQuest is a web-based social platform that provides centralized solutions for job seekers.

Centralized solutions include interactive forum, job application log, interview preparation, and a resouce page.

Link to the video (live demo from CUNYCodes night): https://www.youtube.com/watch?v=uNeC0QaZ4Vs

RESTful API Reference

Note: Items in italics require user authentication.

All requests that deal with posts

  • View all posts: GET /posts
  • Create a new post: POST /posts/create
    • Requires title, thread
  • View specific post: GET /posts/[PostId]/show
    • [PostId] is the unique 9 character ID of the post
  • Edit a post: POST /posts/[PostId]/edit
    • A new title and/or thread must be provided, otherwise old values will remain
  • Delete a post: DELETE /posts/[PostId]/remove
  • Vote on a post: POST /vote/[TypeId]/[PostId]
    • [TypeId] can be 'up' to vote up or 'down' to vote down

All requests that deal with comments

  • Create a new comment: POST /posts/[PostId]/comments/create
  • Edit a comment: POST /posts/[PostId]/comments/[CommentId]/edit
    • [CommentId] follows the same convention as [PostId]
  • Remove a comment: DELETE /posts/[PostId]/comments/[CommentId]/remove

All requests that deal with applications

  • View all applications: GET /applications
  • Create a new application: POST /applications/create
    • Requires company, role, status and comment (optional)
  • View specific application: GET /applications/[ApplicationId]/show
    • [ApplicationId] is the unique 9 character ID of the application
  • Edit an application: POST /applications/[ApplicationId]/edit
    • A new company, role, status and/or comment must be provided, otherwise old values will remain
  • Delete an application: DELETE /applications/[ApplicationId]/remove

All requests that deal with reddit

  • View posts from a subreddit: GET /reddit/:Subreddit/:Sort
    • [Subreddit] is the name of the subreddit (e.g. cscareerquestions)
    • [Sort] is the sorting method that should be applied (hot/new/top/controversial)
  • Search posts from a subreddit: POST /reddit/:Subreddit/search
    • Requires searchterm

All requests that deal with interview questions

  • View all interview questions: GET /interviewQuestions
  • Create a new interview question: POST /interviewQuestions/create
    • Requires topic, title, question and one originalAnswer
  • View specific interview question: GET /interviewQuestions/[QuestionId]/show
    • [QuestionId] is the unique 9 character ID of the question
  • Edit an interview question: POST /interviewQuestions/[QuestionId]/edit
    • A new topic, title, question and originalAnswer must be provided, otherwise old values will remain
  • Delete an interview question: DELETE /interviewQuestions/[QuestionId]/remove

All requests that deal with additional answers to any interview question

  • Create a new answer: POST /interviewQuestions/[QuestionId]/answers/create
    • Requires answerText
  • Edit an answer: POST /interviewQuestions/[QuestionId]/answers/[AnswerId]/edit
    • [AnswerId] follows the same convention as [QuestionId]
  • Remove an answer: DELETE /interviewQuestions/[QuestionId]/answers/[AnswerId]/remove