What to read, to watch, to listen

Retrieval Practice: A Powerful Strategy to Improve Learning

What's new

05.05.2019 - add quote and explanation fields for Quiz

TODO

Add endpoints to create classroom to help collect statistics, responses from students in real time

Introduction

Welcome to the Quiz API! You can use our API to access Quiz API endpoints, which can get information on various quizpacks, quizzes in our database.

Authorization

We expects for the API key to be included in some API requests to the server in a header that looks like the following:

Authorization: 9quizquizquiz9

You must replace 9quizquizquiz9 with your personal API key.

Registration

To register new user, download our Android app

Recieve Authorization token

# With shell, you can just pass the correct header with each request
curl -d "email=<youremail>&password=<password>"  -X POST "http://95.216.145.170:5000/api/users/login"

{
    "success": true,
    "token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVjYWM2MTNmNDkyMTY5MTQ0MzJjNjg2ZCIsIm5hbWUiOiJuaWNrMiIsImlhdCI6MTU1NjQ4NTM5OCwiZXhwIjoxNTU2NDg4OTk4fQ.MJaRcH-vOWQpmpOMHPHzIov_skOGNgvFAbTs8OsfsFQ"
}

Quizpacks

Get All Quizpacks

curl "http://95.216.145.170:5000/api/quizpack"

[
    {
        "_id": "5c8f60211e909c5086d6a991",
        "title": "Переваги STP 2",
        "private": false
    },
    {
        "_id": "5cb0d9cefb6220631b12cb3a",
        "title": "Explore nanotechnology in the wild",
        "private": true
    }
]

HTTP Request

GET http://95.216.145.170:5000/api/quizpack

Get a Specific (public) Quizpack

curl -X POST "http://95.216.145.170:5000/api/quizpack/<ID>"

{
    "tags": [],
    "_id": "5ca26cb4746a040ba0f94983",
    "title": "ЩО ТАКЕ НАНОТЕХНОЛОГІЇ ? ",
    "user": "5c86a8ed622bc01844b77b90",
    "private": false,
    "password": "",
    "quizzes": [
        {
            "_id": "5ca26f83746a040ba0f9498d",
            "quiz": {
                "_id": "5ca26d0e746a040ba0f94984",
                "question": "Якими розмірами оперують нанотехнології ?",
                "type": "one-answer",
                "answers": [
                    {
                        "_id": "5ca26d0e746a040ba0f94987",
                        "answer": "від 5 до 200 нм",
                        "correct": "false"
                    },
                    {
                        "_id": "5ca26d0e746a040ba0f94986",
                        "answer": "від 1 до 100 нм",
                        "correct": "true"
                    },
                    {
                        "_id": "5ca26d0e746a040ba0f94985",
                        "answer": "від 10 до 100 нм",
                        "correct": "false"
                    }
                ],
                "user": "5c86a8ed622bc01844b77b90",
                "__v": 0
            }
        }
    ],
    "__v": 0
}

This endpoint retrieves a specific quizpacks.

HTTP Request

POST http://95.216.145.170:5000/api/quizpack/<ID>

URL Parameters

Parameter	Description
ID	The ID of the quizpack to retrieve

Get a Specific (private) Quizpack

curl -d "password=quizpack_password" -X POST "http://95.216.145.170:5000/api/quizpack/<ID>"

Example:
curl -d "password=1234567" -X POST "95.216.145.170:5000/api/quizpack/5cc4af92a6f1412f6f89d366"

You must replace quizpack_password with quizpack password, ID with quizpack's ID

{
    "tags": [],
    "_id": "5ca26cb4746a040ba0f94983",
    "title": "ЩО ТАКЕ НАНОТЕХНОЛОГІЇ ? ",
    "user": "5c86a8ed622bc01844b77b90",
    "private": false,
    "password": "",
    "quizzes": [
        {
            "_id": "5ca26f83746a040ba0f9498d",
            "quiz": {
                "_id": "5ca26d0e746a040ba0f94984",
                "question": "Якими розмірами оперують нанотехнології ?",
                "type": "one-answer",
                "answers": [
                    {
                        "_id": "5ca26d0e746a040ba0f94987",
                        "answer": "від 5 до 200 нм",
                        "correct": "false"
                    },
                    {
                        "_id": "5ca26d0e746a040ba0f94986",
                        "answer": "від 1 до 100 нм",
                        "correct": "true"
                    },
                    {
                        "_id": "5ca26d0e746a040ba0f94985",
                        "answer": "від 10 до 100 нм",
                        "correct": "false"
                    }
                ],
                "user": "5c86a8ed622bc01844b77b90",
                "__v": 0
            }
        }
    ],
    "__v": 0
}

This endpoint retrieves a specific private quizpack.

HTTP Request

POST http://95.216.145.170:5000/api/quizpack/<ID>

URL Parameters

Parameter	Description
ID	The ID of the quizpack to retrieve

Body Parameters

Parameter	Description
password	The password of the quizpack to retrieve

Create a Quizpack

curl "http://95.216.145.170:5000/api/quizpack/add-quizpack"
  -X POST
  -d "title=newQUIZPACK&private=false"
  -H "Authorization: 9quizquizquiz9"

You must replace 9quizquizquiz9 with your personal API key. To get API key, use our endpoint (see section about)

{
    "msg": "Successfully add newQuizPack",
    "id": "5cc60cf6907b972d25b651ba"
}

This endpoint create new quizpack.

HTTP Request

POST http://95.216.145.170:5000/api/quizpack/add-quizpack

Body Parameters

Parameter	Description	Default
title*	The title of the new quizpack
type*	one-answer or mulitple-choise
private	true or false	false
password	If you want to create private quizpack, set password (between 7 and 20 characters)
quizzes	Array of quizze's id `or` array of quiz objects	[]
tags	Array of strings	[]

{"question":"who is Boosh", "type" :"one-answer","answer1":"american president","answer2":"comedian","correct":["1"]}

Delete a Quizpack

curl "http://95.216.145.170:5000/api/quizpack/<ID>"
  -X DELETE
  -H "Authorization: 9quizquizquiz9"

You must replace 9quizquizquiz9 with your personal API key.

{
  "id": 2,
  "deleted" : "ok"
}

This endpoint deletes a specific quizpack.

HTTP Request

DELETE http://95.216.145.170:5000/api/quizpack/<ID>

URL Parameters

Parameter	Description
ID	The ID of the quizpack to delete

Modify a Quizpack

curl "http://95.216.145.170:5000/api/quizpack/<ID>"
  -X PATCH
  -d "title=<newtitle>&tags=['new']"
  -H "Authorization: 9quizquizquiz9"

You must replace 9quizquizquiz9 with your personal API key.

{
  "id": 2,
  "modify" : "ok"
}

curl "http://95.216.145.170:5000/api/quizpack/5cc60cf6907b972d25b651ba"
  -X PATCH
  -d "tags=['new tag']"
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVjYWM2MTNmNDkyMTY5MTQ0MzJjNjg2ZCIsIm5hbWUiOiJuaWNrMiIsImlhdCI6MTU1NjUyNTkwMiwiZXhwIjoxNTU2NTI5NTAyfQ.iNc7fhn_IFvBeu9A43zycqCwXd9Y8bd5T-XjnXsTV4A"

This endpoint modify a specific quizpack.

HTTP Request

PATCH http://95.216.145.170:5000/api/quizpack/<ID>

URL Parameters

Parameter	Description
ID	The ID of the quizpack to modify

Search Quizpacks

curl "http://api/quizpack/search"
  -X POST
  -d "searchString=test"

This endpoint search quizpacks.

HTTP Request

POST http://95.216.145.170:5000/api/quizpack/search

URL Parameters

Parameter	Description
searchString	Words that must be in title of quizpacks

Add Quiz to the Quizpack

curl "http://api/quizpack/:quizpackID/addquiz/:quizID"
  -X POST

This endpoint add quiz to the quizpack.

HTTP Request

POST http://95.216.145.170:5000/api/quizpack/:quizpackID/addquiz/:quizID

URL Parameters

Parameter	Description
quizpackID	Quizpack id
quizID	Quiz id, quiz must be already created

Quiz

Create a Quiz

{
    "msg": "Successfully add newQuiz",
    "id": "5cc60cf6907b972d25b651ba"
}

This endpoint create new quiz.

HTTP Request

POST http://95.216.145.170:5000/api/quiz/add

Body Parameters

Parameter	Description	Default
question*	The question of the new quiz
type*	one-answer or multiple-choice
answer1*	String
answer2*	String
answer3	String
answer4	String
answer5	String
answer6	String
correct*	Array correct answer (min =1,max=6)
quote	String, max length 2000 characters
explanation	String, max length - 5000 characters

{"question":"who is Boosh", "type" :"one-answer","answer1":"american president","answer2":"comedian","correct":["1"]}

Modify a Quiz

curl "http://localhost:5000/api/quiz/5cc60cf6907b972d25b651b7"  
-X PATCH -d "question=WhoIsBoosh&tags=['new']" -H "Authorization: Bearer ..."

{"_id":"5cc60cf6907b972d25b651b7","question":"WhoIsBoosh","type":"one-answer",
"answers":[
  {"_id":"5cc60cf6907b972d25b651b9","answer":"american president","correct":"false"},{"_id":"5cc60cf6907b972d25b651b8","answer":"comedian","correct":"false"}
],
"user":"5cac613f49216914432c686d","__v":0}

This endpoint modify a specific quiz.

HTTP Request

PATCH http://95.216.145.170:5000/api/quiz/<ID>

URL Parameters

Parameter	Description
ID	The ID of the quiz to modify

Errors

The API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The item requested is hidden for administrators only.
404	Not Found -- The specified item (quiz, quizpack) could not be found.
405	Method Not Allowed -- You tried to access a item with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The iten requested has been removed from our servers.
418	I'm a teapot.
429	Too Many Requests -- You're requesting too many item! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.