api/pageplace.family-v1-myself.rst

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