api/pageplace.family-v1-family.rst

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