c791158041dcf6bd4b1d68532ed511bef94c705d
[tolino-api-docs.git] / api / pageplace.bosh-bosh-rest-dictionary-list.rst
1 ===========================================================
2 ``GET https://bosh.pageplace.de/bosh/rest/dictionary/list``
3 ===========================================================
4
5 Fetch the list of downloadable dictionaries.
6
7 Part of the `sync process`_.
8
9
10 Request
11 =======
12 Header
13   ``t_auth_token``
14     OAuth token obtained from `POST https://thalia.de/auth/oauth2/token`_.
15
16     Example: ``eyJhbGciOiJSUzI1NiJ9.eyJhdWRpZW5jZSI6InRyZWFkZXJ2aXNpb24zIiw...``
17   ``Accept``
18     Example: ``application/json; charset=UTF-8``
19   ``m_id``
20     FIXME: Maybe reseller ID?
21
22     Example: ``3``
23   ``hardware_id``
24     Seems to be the same as the ``xxx`` value in the URL.
25
26     Example: ``665fc389ef4e47258c5db9fa7821bd19``
27   ``Content-Type``
28     ``application/json; charset=UTF-8``
29
30     This is a lie; there is no request body.
31   ``client_type``
32     Example: ``TOLINO_VISION_3``
33   ``client_version``
34     Example: ``14.1.0``
35
36 No request body.
37
38
39 Response
40 ========
41 HTTP status code ``200 OK``.
42
43 Example:
44
45 .. include:: pageplace.bosh-bosh-rest-dictionary-list.response.json
46    :code: