First part of the setup process
[tolino-api-docs.git] / api / pageplace.bosh-bosh-rest-reseller-countries.rst
1 ==============================================================
2 ``GET https://bosh.pageplace.de/bosh/rest/reseller/countries``
3 ==============================================================
4
5 Fetch list of countries the e-reader can be used with.
6
7 Step 1 of the `Setup process`_.
8
9 ``pageplace.de`` seems to have a list of hardware IDs and their
10 associated sellers.
11 E-reader devices sold by thalia.de can only choose thalia as book shop
12 when it is being setup.
13
14 Only those countries are returned that the device seller is available in.
15
16 Request
17 =======
18 Header
19   ``hardware_id``
20     Required.
21
22     Example: ``665fc389ef4e47258c5db9fa7821bd19``
23   ``client_type``
24     Example: ``TOLINO_VISION_3``
25   ``client_version``
26     Example: ``14.1.0``
27
28 GET parameters
29   ``languageCode``
30     Two-letter e-reader interface language code.
31
32     Does not seem to have any influence on the response.
33
34     Example: ``en``
35
36 Response
37 ========
38
39 Non-rebrandable device
40 ----------------------
41 HTTP status code ``200 OK``.
42
43 Has ``rebrandable`` property set to ``false``.
44
45 Example:
46
47 .. include:: pageplace.bosh-bosh-rest-reseller-countries.response.json
48    :code:
49
50
51 Missing hardware_id header
52 --------------------------
53 When no hardware_id is passed, a ``404 Not Found`` status code is returned
54 together with an error message:
55
56 .. include:: pageplace.bosh-bosh-rest-reseller-countries.response-nohardwareid.json
57    :code: