This repository was archived by the owner on Dec 10, 2017. It is now read-only.

API Reference

Jump to bottom

Jan-Luca Klees edited this page May 9, 2017 · 5 revisions

API-Endpoints

Base-URL

api.dontusethisinproduction.fail/v3
All paths are relative to the base URL.

This is work in progress.

Use of HTTP Verbs

We are trying to use the appropriate HTTP verb for accessing each endpoint according to REST specification where possible:

Verb	Description
`GET`	Retrieve one or multiple resources
`POST`	Create a resource
`PUT`	Update a resource
`PATCH`	Update a resource (partially)
`DELETE`	Delete a resource

Learning-lists

`/lists/`

GET all lists, paginated
POST to create a new list

`/lists/search/`

GET lists matching the search / filters, paginated

`/lists/<id>/`

GET one list by id, meta + first page of entries, requires paging parameter

`/lists/<id>/meta/`

GET get list meta
PUT new meta information for the list
PATCH existing meta information for the list

`/lists/<id>/entries/`

GET list entries, paginated
POST a new entry to be added to the list of entries
PUT new information for an entry
PATCH existing information of an entry
DELETE an entry

Dictionary

`/dict/search/`

GET search results

`/dict/details/<id>/`

GET details about a specific entry in the dictionary

Quizzes

proposed base: /quizzes

Users

proposed base: /user