Examplar

Dev | Master

The Exam Search Tool

Development

A Web app for searching exam papers, questions and content.

Languages:

• JS
• HTML
• CSS

---

Technologies:

• Postgres
• Express
• NodeJS
• Vue

Documentation

API Routes

HTML Version

Examplar API

version: 0.0.1

examplar.herokuapp.com/api

/search

Queries the Question table for questions like the term entered.

get /search/{term}

Returns JSON object based upon SQL query to get questions like {term}

URI Parameters

• term: required (string)

  The term used to fetch questions.

Query Parameters

• pretty: (boolean)

  prettifies JSON output.

HTTP status code 200

Body

Type: application/json

Properties:

QuestionId: int
QuestionNumber: int
QuestionText:  string
ExamPaperUnit: string
ExamPaperSeason: string
ExamPaperDate: date
ExamBoardName: string
LevelTitle: string
SubjectTitle: string

Example:

{
  "QuestionId": 7,
  "QuestionNumber": 7,
  "QuestionText": "Describe a method that can, without the use of binary addition, multiply any unsigned\r\nbinary integer by the binary number 10 (the denary number 2).",
  "ExamPaperUnit": "COMP1",
  "ExamPaperSeason": "Summer",
  "ExamPaperDate": "2014-06-02T00:00:00.000Z",
  "ExamBoardName": "AQA",
  "LevelTitle": "AS",
  "SubjectTitle": "Computing"
}

/result

Fetches result based upon an ID parsed.

get /result/{id}

Returns JSON object based upon the id parsed.

URI Parameters

• id: required (integer)

  ID for the result

Query Parameters

• pretty: (boolean)

  prettifies JSON output.

HTTP status code 200

Body

Type: application/json

Properties:

/image

/more

/related

/examiner

/filter

Database

* Primary Key ^ Foreign Key

ExamBoard

ExamBoardId*
ExamBoardName

Level

LevelId*
LevelTitle

---

Subject

SubjectId*
SubjectTitle

---

Topic

TopicId*
TopicTitle

---

Specification

SpecificationCode*
ExamBoardId^
SubjectId^
LevelId^
SpecificationTitle

---

ExamPaper

ExamPaperId*
ExamBoardId^
LevelId^
SubjectId^
ExamPaperSeason
ExamPaperDate

---

QuestionImage

QuestionImageId*
QuestionImageData

---

Examiner

ExaminerId*
ExaminerText

---

Question

QuestionId*
ExamPaperId^
ExaminerId^
QuestionImageId^
QuestionNumber
QuestionText
QuestionMarks
QuestionMarkText

---

QuestionTopic (Link Table)

QuestionId*
TopicId*

---

ExamPaperQuestion (Link Table)

ExamPaperId*
QuestionId*