Work in progress #6: Define header sets
[tolino-api-docs.git] / 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   See `family v1 header set`_.
19
20 No request body.
21
22
23 Response
24 ========
25 HTTP status code ``200 OK``.
26
27
28 Family members
29 --------------
30 Example:
31
32 .. include:: pageplace.family-v1-shares.response-2books.json
33    :code: