2aaae295e4128cd1b5279e4c52c0423ac8ebee82
[tolino-api-docs.git] / api / pageplace.bosh-bosh-rest-userid-xxx.rst
1 ======================================================
2 ``GET https://bosh.pageplace.de/bosh/rest/userid/xxx``
3 ======================================================
4 Step 5 in the `Login process`_.
5
6 FIXME: Check if the device has been registered already to a user.
7
8 Example ``xxx`` value: ``665fc389ef4e47258c5db9fa7821bd19``.
9
10 There is some explanation about the hardware id in
11 `tolino-python: tolinocloud.py <https://github.com/hzulla/tolino-python/blob/c655dbcd1b23e3874fd7dc78736570ac27ff5123/tolinocloud.py#L42>`_.
12
13
14 Request
15 =======
16 No body in the request, despite the ``Content-Type`` header.
17
18 Header
19   ``t_auth_token``
20     OAuth token obtained from `POST https://thalia.de/auth/oauth2/token`_.
21
22     Example: ``eyJhbGciOiJSUzI1NiJ9.eyJhdWRpZW5jZSI6InRyZWFkZXJ2aXNpb24zIiw...``
23   ``Accept``
24     ``application/json; charset=UTF-8``
25   ``m_id``
26     FIXME: Maybe reseller ID?
27
28     Example: ``3``
29   ``hardware_id``
30     Seems to be the same as the ``xxx`` value in the URL.
31
32     Example: ``665fc389ef4e47258c5db9fa7821bd19``
33   ``Content-Type``
34     ``application/json; charset=UTF-8``
35   ``client_type``
36     Example: ``TOLINO_VISION_3``
37   ``client_version``
38     Example: ``14.1.0``
39
40
41 Response
42 ========
43 HTTP status code: ``200 OK``
44
45 Example:
46
47 .. include:: pageplace.bosh-bosh-rest-userid-xxx.response.json
48    :code: