...
ATOM Inventory XML format for v2
For v2 some fields are removed, contact us if we have removed fields that are important for your process.
Example XML:
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:inv="http://bokbasen.no/module/inventory/1.0">
<title>Inventory Items</title>
<link rel="self" type="application/atom+xml" href="http://api.dds.boknett.no/inventory/" title="Inventory feed" />
<updated>2015-08-07T11:19:45Z</updated>
<entry>
<id>urn:uuid:99496f82-84c5-4de7-9899-31603e26a355</id>
<updated>2015-08-06T11:52:09Z</updated>
<inv:isbn>9788242160966</inv:isbn>
<inv:publisher>900224</inv:publisher>
<inv:format>MP3</inv:format>
<inv:drm>SDRM</inv:drm>
<inv:version>1</inv:version>
<inv:deleted />
<inv:published>true</inv:published>
<inv:access>false</inv:access>
<inv:excerpt>false</inv:excerpt>
</entry>
</feed> |
Inventory XML element documentation
| Element | Explanation |
|---|---|
<title> | Title of book |
<author>/ <name> | Name of author |
<id> | The id of the digital resource representing the book. (Referred to as uuid or reId) Note that this ID can change at any time if the publisher of the book publishes a new version of the digital file. |
<updated> | Last time resource was updated |
<inv:isbn> | ISBN of book |
<inv:publisher> | Id of publisher |
<inv:format> | Format of the file (always MP3 for audio books even if they are distributed in different formats) |
<inv:drm> | What kind of DRM protection the book have, possible values are: SDRM, TDRM, NODRM, or UNKNOWN |
<inv:version> | Version number for the digital resource. Starts with 1 and increments if new version of the digital book is published. |
<inv:firstpublished> | Date book was first published |
<inv:deleted> | Date book was deleted (empty value if not deleted) |
<inv:published> | If the books in published, you cannot initiate downloads on a book that is not published. |
<inv:access> | Role based, do you as an integrator have access to this book? Must be true in order for you to sell the title. |
<inv:excerpt> | If excerpts are available through DDS. (Will always be false for audio books as these are distributed through the metadata API.) |
...
The get inventory service can give data on your entire catalogue or detailed information on one specific title.
| URL | https://api.dds.boknett.no/inventory/ | ||||||||
| Method | GET | ||||||||
| Request headers | Authorization | Required | The token acquired from the Authentication Service. Formated "Boknett TGT-...." | ||||||
| Date | Required | The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT | |||||||
| Query parameters | id | Optional | UUID (also called resId) of the ebook that you want information about, use this parameter only if you want detailed information about one single title. | ||||||
| isbn | Optional | Same as id only based on isbn to give information about a specific title (will always reply with data on latest version of digital book for the isbn) | |||||||
| fromDate | Optional | From date for the response dataset | |||||||
toDate | Optional | The type of notification, which can be updated (new and updated elements) and deleted. Empty or missing parameter will result in both updated and deleted elements. | |||||||
| state | Optional* | Status that can be used for filtering. *If fromDate or toDate is given, this is mandatory Possible values:
| |||||||
| Response headers | Content-Type | application/atom+xml;charset=UTF-8 | |||||||
| Response body | ATOM Inventory XML format (see details further down on this page) | ||||||||
| Returns | 200 | OK | |||||||
| 40x | On error | ||||||||
Details on state and fromDate / toDate parameters
...