api/pageplace.family-v1-shares-post.rst

   1 ==============================================
   2 ``POST https://family.pageplace.de/v1/shares``
   3 ==============================================
   4
   5 Share a book with a family member
   6
   7
   8 Request
   9 =======
  10 Header
  11   See `family v1 header set`_.
  12
  13 Body
  14   JSON-Encoded. Structure:
  15
  16   ``shares``
  17     Array of books to share (each an object)
  18
  19     ``publicationId``
  20       Example: ``DT0400.9783641243609_A40398678``
  21     ``receiver``
  22       Example: ``67674``
  23
  24
  25 .. include:: pageplace.family-v1-shares-post.request.json
  26    :code:
  27
  28 Response
  29 ========
  30 HTTP status code ``200 OK``.
  31
  32 No response body (thus status code should better be 204).