api/pageplace.inventory-v2-inventory.rst

   1 ===================================================
   2 ``GET https://inventory.pageplace.de/v2/inventory``
   3 ===================================================
   4 Fetch information about books stored in the cloud.
   5
   6 Part of the `sync process`_.
   7
   8
   9 Request
  10 =======
  11 Full example request URL::
  12
  13     https://inventory.pageplace.de/v2/inventory?page=0&size=300&includeLoaned=true&contentTypeFilter=EBOOK&contentFormatFilter=ACSM&contentFormatFilter=EPUB&contentFormatFilter=PDF
  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 GET parameters
  49   ``fullResponse``
  50     Optional. Values: ``true``
  51   ``page``
  52     Example: ``0``
  53   ``size``
  54     Example: ``300``
  55   ``includeLoaned``
  56     Example: ``true``
  57   ``contentTypeFilter``
  58     Example: ``EBOOK``
  59   ``contentFormatFilter``:
  60     Multiple values allowed (repeat the parameter)
  61
  62     Allowed values:
  63       - ``ACSM``
  64       - ``EPUB``
  65       - ``PDF``
  66
  67
  68 Response
  69 ========
  70 Header
  71   ``Content-Type``
  72     ``application/json;charset=UTF-8``
  73
  74 Example:
  75
  76 .. include:: pageplace.inventory-v2-inventory.response.json
  77    :code: