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   See `bosh v1 header set`_
  16 GET parameters
  17   ``count``
  18     Number of recommendations to return
  19
  20     Example: ``12``
  21   ``fullShopUrl``
  22     ``true``
  23
  24
  25 Response
  26 ========
  27 HTTP status code ``200 OK``.
  28
  29
  30 Response body definition
  31 ------------------------
  32
  33 ``publicationType``
  34   Can be empty or one of: ``EBOOK``, ``EMAGAZINE``, ``EPAPER`` or ``EDATA``.
  35   Not used.
  36
  37
  38 Example
  39 -------
  40
  41 .. include:: pageplace.bosh-bosh-rest-recommendation-xyz.response.json
  42    :code: