Books

APIDescription
GET books/{bookId}

Get book by id. User Authorization Optional.

GET Books?Page={Page}&PageSize={PageSize}&NextPage={NextPage}&PreviousPage={PreviousPage}&FirstPage={FirstPage}&LastPage={LastPage}

Get books of the bible. User Authorization Optional.

Users

APIDescription
POST login

User login. User Authorization Optional.

POST Users

Create a user. User Authorization None.

PATCH Users

Update a user. User Authorization Required.

GET Users/{id}

Get user by id. User Authorization Required.

Categories

APIDescription
GET categories/{categoryId}

Get category by id. User Authorization Optional.

GET categories/categorygroups/{categoryGroupId}?Page={Page}&PageSize={PageSize}&NextPage={NextPage}&PreviousPage={PreviousPage}&FirstPage={FirstPage}&LastPage={LastPage}

Get categories by group. User Authorization Optional.

GET categorygroups?Page={Page}&PageSize={PageSize}&NextPage={NextPage}&PreviousPage={PreviousPage}&FirstPage={FirstPage}&LastPage={LastPage}

Get all category groups. User Authorization Optional.

GET categorygroups/{categoryGroupId}

Get category group by id. User Authorization Optional.

GET Categories?Page={Page}&PageSize={PageSize}&NextPage={NextPage}&PreviousPage={PreviousPage}&FirstPage={FirstPage}&LastPage={LastPage}

Get all categories. User Authorization Optional.

Questions

APIDescription
GET questions/{questionId}

Get question by id. User Authorization Optional.

GET questions/singlerandom?difficulty={difficulty}&allDifficulties={allDifficulties}&fineGrainedDifficulty={fineGrainedDifficulty}&usedQuestions={usedQuestions}

Convenience api call to get a single random question. User Authorization Optional.

GET questions/categories/{categoryId}?Page={Page}&PageSize={PageSize}&NextPage={NextPage}&PreviousPage={PreviousPage}&FirstPage={FirstPage}&LastPage={LastPage}&difficulty={difficulty}&random={random}&randomCount={randomCount}&allDifficulties={allDifficulties}&fineGrainedDifficulty={fineGrainedDifficulty}&usedQuestions={usedQuestions}

Get questions by category. User Authorization Optional.

GET questions/singlerandom/categories/{categoryId}?difficulty={difficulty}&allDifficulties={allDifficulties}&fineGrainedDifficulty={fineGrainedDifficulty}&usedQuestions={usedQuestions}

Convenience api call to get a single random question by category. User Authorization Optional.

GET questions/categorygroups/{categoryGroupId}?Page={Page}&PageSize={PageSize}&NextPage={NextPage}&PreviousPage={PreviousPage}&FirstPage={FirstPage}&LastPage={LastPage}&difficulty={difficulty}&random={random}&randomCount={randomCount}&allDifficulties={allDifficulties}&fineGrainedDifficulty={fineGrainedDifficulty}&usedQuestions={usedQuestions}

Get questions by category group. User Authorization Optional.

GET questions/singlerandom/categorygroups/{categoryGroupId}?difficulty={difficulty}&allDifficulties={allDifficulties}&fineGrainedDifficulty={fineGrainedDifficulty}&usedQuestions={usedQuestions}

Convenience api call to get a single random question by category group. User Authorization Optional.

POST answers

Post user's answer to a question. User Authorization Required.

GET Questions?Page={Page}&PageSize={PageSize}&NextPage={NextPage}&PreviousPage={PreviousPage}&FirstPage={FirstPage}&LastPage={LastPage}&difficulty={difficulty}&random={random}&randomCount={randomCount}&allDifficulties={allDifficulties}&fineGrainedDifficulty={fineGrainedDifficulty}&usedQuestions={usedQuestions}

Get questions. User Authorization Optional.

POST Questions

Add a new question from the user to the new question log. User Authorization Optional.

Sitemap

APIDescription
GET sitemap/{id}?offset={offset}&limit={limit}

Get the sitemap. User Authorization Optional.

QuestionStats

APIDescription
GET QuestionStats/{id}

Get stats for a question. User Authorization Optional.

UserStats

APIDescription
GET UserStats?Page={Page}&PageSize={PageSize}&NextPage={NextPage}&PreviousPage={PreviousPage}&FirstPage={FirstPage}&LastPage={LastPage}&byQuestions={byQuestions}

Get user rankings. User Authorization Optional.

GET UserStats/{id}

Get user stats by user id. User Authorization Required.

Newsletters

APIDescription
POST Newsletters

Subscribe to newsletter. User Authorization Optional.