api/pageplace.bosh-bosh-rest-recommendation-xyz.rst

   1 ==============================================================
   2 ``GET https://bosh.pageplace.de/bosh/rest/recommendation/xyz``
   3 ==============================================================
   4
   5 Get advertisements for the main reader screen.
   6
   7 FIXME: Why the ``xyz`` in the URL?
   8
   9 Part of the `sync process`_.
  10
  11
  12 Request
  13 =======
  14 Header
  15   ``t_auth_token``
  16     OAuth token obtained from `POST https://thalia.de/auth/oauth2/token`_.
  17
  18     Example: ``eyJhbGciOiJSUzI1NiJ9.eyJhdWRpZW5jZSI6InRyZWFkZXJ2aXNpb24zIiw...``
  19   ``Accept``
  20     Example: ``application/json; charset=UTF-8``
  21   ``m_id``
  22     FIXME: Maybe reseller ID?
  23
  24     Example: ``3``
  25   ``hardware_id``
  26     Seems to be the same as the ``xxx`` value in the URL.
  27
  28     Example: ``665fc389ef4e47258c5db9fa7821bd19``
  29   ``Content-Type``
  30     ``application/json; charset=UTF-8``
  31
  32     This is a lie; there is no request body.
  33   ``client_type``
  34     Example: ``TOLINO_VISION_3``
  35   ``client_version``
  36     Example: ``14.1.0``
  37 GET parameters
  38   ``count``
  39     Number of recommendations to return
  40
  41     Example: ``12``
  42   ``fullShopUrl``
  43     ``true``
  44
  45
  46 Response
  47 ========
  48 HTTP status code ``200 OK``.
  49
  50 Example:
  51
  52 .. include:: pageplace.bosh-bosh-rest-recommendation-xyz.response.json
  53    :code: