Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Local ONIX best pratices, Added Content detail effective from 16 May 2023 and Changed the order of Local ONIX best practices topics to match the order in the ONIX Product record

...

Document revision history

Date

Version


 

v 3.6

Local ONIX best pratices

  • Added: Content detail effective from 16 May 2023
  • Changed: the order of Local ONIX best practices topics to match the order in the ONIX Product record

 

v 3.5Added to ProductAvailability: Announcements, effective from 1 Dec 2022

 

v 3.4Cancel an order is no longer supported

 

v3.3Added to 5.3.7:  RelatedProduct

 

v3.2

Timezone: CET/CEST (= UTC+2) added at 4.2 Catalogue metadaata in ONIX 3 format - modifiedfrom

 

v3.1
  • Major revision, chapters renumbered
  • ONIX explanation added
  • Reset download links explained
  • New feature: order cancelation (in 7-day window)
  • Reseller client dashboard updated
  • References to Luisterhuis ProductID changed to EAN13
  • App API removed

 

v3.0 

Draft

  • App API renamed
  • Support for Ecosystem clients removed, now in separate document

 

v2.8
  • New v3 endpoints to replace v2
  • endpoints Changes in default LIMIT and OFFSET values

 

v2.7
  • Updated ONIX examples (chapter 4, chapter 12).
  • Improved explanation Inventory API (chapter 4.3).
  • Wrong chapter number references corrected.

 

v2.6Facetted search (chapter 4) deprecated and phased out. Removed from documentation.

 

v2.5
  • New stub endpoints (stub-www replaces stub.www; stub-rest replaces stub.rest).
  • New ONIX 3.0 /v2/feed endpoints added (Chapter 4). Please note: old endpoints will be phased out. Textual changes: settlement renamed to monthly settlement; extra explanation about different usage modes and business models.
  • Usage API added (chapter 8)

 

v2.4
  • Settlement API added (chapter 7) Textual changes
  • Wrong URL in earlier documentation: all restful end points changed to rest.luisterhuis.nl

 

v2.3Textual changes

 

v2.2
  • Support for retrieving metadata for all products in a single inventory call (chapter 4.4)
  • Extra value 'CustomerID' in API call submitOrder (chapter 5.4)
  • New features Luisterhuis portal for resellers (reactivate download link, csv download) Support for apps Support for Ecosystem clients
  • Support for private content
  • feeds Updated ONIX and XML examples

 

v2.1
  • Support for NSTC (Dutch equivalent for ISTC) in ONIX 3 metadata
  • Additional audiobook metadata (square images, update date/time images, mp3 files)

 

v2.0
  • Rewritten documentation, now including description of 2 interface scenarios
  • New API function: update by date
  • Deprecated API function: send downloadlink by email removed from documentation

 

v1.4New API function: orders accepted by product ID or EAN13

 

v1.3New API function: send download link by email

 

v1.2Bug fixes

 

v1.1Stub (testing) environment added

 

v1.0 First release

...

Code Block
languagexml
titleSample audio file asset
<SupportingResource>
 <ResourceContentType>15</ResourceContentType>
 <ContentAudience>00</ContentAudience>
 <ResourceMode>02</ResourceMode>
 <ResourceVersion>
  <ResourceForm>02</ResourceForm>
  <ResourceVersionFeature>
   <ResourceVersionFeatureType>01</ResourceVersionFeatureType>
   <FeatureValue>A103</FeatureValue>
  </ResourceVersionFeature>
  <ResourceVersionFeature>
    <ResourceVersionFeatureType>04</ResourceVersionFeatureType>
    <FeatureValue>sample.mp3</FeatureValue>
  </ResourceVersionFeature>
  <ResourceLink datestamp="20200903T110746">https://assets.luisterhuis.nl/sample/377dfd1e-731a-4047-8040-ee051231f2b1</ResourceLink>
  <ContentDate>
   <ContentDateRole>01</ContentDateRole>
   <Date dateformat="00">20200129</Date>
  </ContentDate>
 </ResourceVersion>
</SupportingResource>

Content Detail

...

The "ContentDetail" element is used in metadata to provide information about the content items in an audiobook, including any chapter or scene titles. This is important for organizing and categorizing the content as well as for helping listeners find the parts they are looking for.

  1. The ContentDetail block consists of multiple ContentItem elements, with each element representing a part of the table of contents.
  2. Each ContentItem element has a LevelSequenceNumber, which indicates the hierarchical position of the corresponding part in the table of contents (1.1, 1.2, 1.3, etc.). 
  3. Within the ContentItem element, there is the AVItem element, which contains an AVItemType with a value of "03".
Code Block
languagexml
titleExample ContentDetail
Example ContentDetail
<ContentDetail>
  <ContentItem>
    <LevelSequenceNumber>1.1</LevelSequenceNumber>
    <AVItem>
      <AVItemType>03</AVItemType>
    </AVItem>
    <TitleDetail>
      <TitleType>01</TitleType>
      <TitleElement>
        <TitleElementLevel>04</TitleElementLevel>
        <TitleText>Proloog</TitleText>
      </TitleElement>
    </TitleDetail>
  </ContentItem>
  <ContentItem>
    <LevelSequenceNumber>1.2</LevelSequenceNumber>
    <AVItem>
      <AVItemType>03</AVItemType>
    </AVItem>
    <TitleDetail>
      <TitleType>01</TitleType>
      <TitleElement>
        <TitleElementLevel>04</TitleElementLevel>
        <TitleText>Hoofdstuk 1</TitleText>
      </TitleElement>
    </TitleDetail>
  </ContentItem>
  <ContentItem>
    <LevelSequenceNumber>1.3</LevelSequenceNumber>
    <AVItem>
      <AVItemType>03</AVItemType>
    </AVItem>
    <TitleDetail>
      <TitleType>01</TitleType>
      <TitleElement>
        <TitleElementLevel>04</TitleElementLevel>
        <TitleText>Hoofdstuk 2</TitleText>
      </TitleElement>
    </TitleDetail>
  </ContentItem>
</ContentDetail>

...