...
Document revision history
Date | Version | |
---|---|---|
| v 3.6 | Local ONIX best pratices
|
| v 3.5 | Added to ProductAvailability: Announcements, effective from 1 Dec 2022 |
| v 3.4 | Cancel an order is no longer supported |
| v3.3 | Added 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 |
|
| v3.0 | Draft
|
| v2.8 |
|
| v2.7 |
|
| v2.6 | Facetted search (chapter 4) deprecated and phased out. Removed from documentation. |
| v2.5 |
|
| v2.4 |
|
| v2.3 | Textual changes |
| v2.2 |
|
| v2.1 |
|
| v2.0 |
|
| v1.4 | New API function: orders accepted by product ID or EAN13 |
| v1.3 | New API function: send download link by email |
| v1.2 | Bug fixes |
| v1.1 | Stub (testing) environment added |
| v1.0 | First release |
...
The following paragraphs describe the specific ONIX implementation and best practices for the Dutch market.
ProductForm and PrimaryContentType
For digital audiobooks, the following <ProductForm> is used:
Code Block | ||||
---|---|---|---|---|
| ||||
<ProductForm>AJ</ProductForm> <ProductFormDetail>A103</ProductFormDetail> <PrimaryContentType>01</ PrimaryContentType> |
The following values for <PrimaryContentType> are supported:
- 01 Audio (audiobook)
- 02 Performance (audio drama, theatre, cabaret)
- 03 Music Recording
- 04 Other Audio (nature sounds, soundscapes)
- 13 Other Speech Content (lectures, interviews, discussions, audio tours)
Title and collection
The ONIX metadata supports the following title and collection elements:
...
It is the responsibility of the web shop to comply with this standard and parse the <PrefixToKey> field.
Abridged / unabridged
The ONIX contains the <EditionType> element which refers to either abridged (content has been shortened in relation to the original book) or unabridged content.
There are 2 possible values for <EditionType> supported:
- ABR Abridged
- UBR Unabridged
Language codes
All audiobooks contain the language code for the text <LanguageRole> 01 and spoken language <LanguageRole> 08, which are always identical. Most translated audiobooks also contain the language code for the original language <LanguageRole> 02.
...
Code Block | ||||
---|---|---|---|---|
| ||||
<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.
- The ContentDetail block consists of multiple ContentItem elements, with each element representing a part of the table of contents.
- 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.).
- Within the ContentItem element, there is the AVItem element, which contains an AVItemType with a value of "03".
Code Block | ||||
---|---|---|---|---|
| ||||
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> |
Related products (ISBN) and related works (NSTC)
...