api/pageplace.family-v1-shares.rst

   1 =============================================
   2 ``GET https://family.pageplace.de/v1/shares``
   3 =============================================
   4
   5 Obtain the list of books shared in the family.
   6
   7 FIXME: Only books that are shared from/to the current user?
   8
   9 Part of the `sync process`_.
  10
  11 This is only called when the user has family member data
  12 (`GET https://family.pageplace.de/v1/myself`_).
  13
  14
  15 Request
  16 =======
  17 Header
  18   ``Authorization``
  19     OAuth token obtained from `POST https://thalia.de/auth/oauth2/token`_.
  20
  21     Example: ``Bearer eyJhbGciOiJSUzI1NiJ9.eyJhdWRpZW5jZSI6InRyZWFkZXJ2aXNpb24zIiw...``
  22   ``Accept``
  23     Example: ``application/json; charset=UTF-8``
  24   ``Accept-Encoding``
  25     ``gzip``
  26   ``m_id``
  27     FIXME: Maybe reseller ID?
  28
  29     Example: ``3``
  30   ``Hardware-Id``
  31     Example: ``665fc389ef4e47258c5db9fa7821bd19``
  32   ``Content-Type``
  33     ``application/json; charset=UTF-8``
  34
  35     This is a lie; there is no request body.
  36   ``client_type``
  37     Example: ``TOLINO_VISION_3``
  38   ``client_version``
  39     Example: ``14.1.0``
  40   ``Reseller-Id``
  41     Example: ``3``
  42   ``Cookie``
  43     Multiple times:
  44
  45     -  ``OAUTH-JSESSIONID=3EFAEC6B69D811252C75861880C338AB.15acdb90; Path=/; Secure; HttpOnly``
  46     - ``JSESSIONID=C0D8A077F6D2E13251ECDCD60FE6D18A``
  47   ``Cookie2``
  48     Example: ``$Version=1``
  49
  50 No request body.
  51
  52
  53 Response
  54 ========
  55 HTTP status code ``200 OK``.
  56
  57
  58 Family members
  59 --------------
  60 Example:
  61
  62 .. include:: pageplace.family-v1-shares.response-2books.json
  63    :code: