Skip to content

Latest commit

 

History

History
74 lines (63 loc) · 2.86 KB

README.md

File metadata and controls

74 lines (63 loc) · 2.86 KB

Interview Bot Server

Ensure that you have the lastest version of Node.js installed and preferably the lastest version of sqlite installed. Once this is done run:

git clone https://github.com/Bachmair-Boys/interview-bot-server
cd interview-bot-server

Running

npm start

Interview Bot API

Category Identification

BASIC = 0
BEHAVIORAL = 1
SALARY = 2
BRAINTEASER = 3

RETURN CODES

SUCCESS = 0
DATABASE_CONNECTION_ERROR = 100
DATABASE_LOOKUP_ERROR = 101

Methods

get-count: POST, Gets the number of questions in a given question category.
Parameters:
    category: int, category identification number to get count from
Return:
    JSON-Encoded Data: {
    status: int, SUCCESS if check succeeded, DATABASE_LOOKUP_ERROR otherwise,
    count: int, number of comments in the requested category
    }

get-question: POST, Gets the requested question number in the requested question category.
Parameters:
    category: int, category identification number to find question in.
    question: int, number of the question in the category
Return:
     JSON-Encoded Data: {
    status: int, SUCCESS if check succeeded, DATABASE_LOOKUP_ERROR otherwise,
    count: int, number of comments in the requested category
    }

create-question: POST, Adds the given question to the database in the requested question category.
Parameters:
    category: int, category identification number to find question in.
    question: string, user created question
Return:
     JSON-Encoded Data: {
    status: int, SUCCESS if check succeeded, DATABASE_LOOKUP_ERROR otherwise,
    }

get-categories: GET, Gets the categories of questions currently in the database.
Parameters:
     None
Return:
     JSON-Encoded Data: {
    status: int, SUCCESS if check succeeded, DATABASE_LOOKUP_ERROR otherwise,
    categories: string[] , number of comments in the requested category
    }

create-categories: GET, Adds the given category of questions into the database.
Parameters:
     category_name: string, name of the new
Return:
     JSON-Encoded Data: {
    status: int, SUCCESS if check succeeded, DATABASE_LOOKUP_ERROR otherwise,
    }