Introduction

This Product Information Format Specification (the Specification) replaces, for ONIX for Books Release 3.0, the separate documents which in previous ONIX releases were given the titles Product Record Format, XML Message Specification and Overview and Data Elements. The change of title reflects the fact that the single Specification document now includes sections describing the top-level XML message structure and the message header as well as the product record itself. This Specification also includes a complete sample message, an overview of the XML data elements and complete lists of XML tags.

Other documentation for Release 3.0 comprises an Introduction to ONIX for Books 3.0, the ONIX for Books Codelists (Issue 12 or later), the ONIX for Books Implementation and Best Practice Guide (the Guide), together with a small number of How to… guides on particular aspects of ONIX 3.0 usage, with detailed examples. There is a separate specification for an Acknowledgement message which may be sent in response to an ONIX Product Information message, and which may form part of a message ‘choreography’ between data sender and recipient.

Although this issue of the Specification is complete in terms of its coverage of the structure and data elements in ONIX 3.0, it may be subject to further revision, not only to correct any errors that are found during the early stages of implementation, but also to add material that may make it easier to use. The codelists – which form an important part of the standard – are also regularly updated. Any revisions will be notified through the ONIX for Books implementation listserv. If you are not already a member, you may wish to sign up through the EDItEUR website.

The Specification includes a number of corrections and additions made after the initial release of ONIX 3.0 documentation, following early proof-of-concept implementation – please note especially the list of corrections below dated 29 October 2010 and earlier. In particular, attention is drawn to the new <ROWSalesRightsType> element which is intended to reduce the variations in interpretation regarding product sales rights information from different ONIX data suppliers. Any ONIX 3 implementations developed prior to this date will likely need updating to incorporate this element. There are also important clarifications in the repeatability of <SupplyDetail> and <Supplier>.

If you believe that you have found an error, or you have a question about this document, please contact EDItEUR either through the listserv or by e-mail to info@editeur.org.

Introduction to Release 3.0 revision 1 (3.0.1)

This revision includes a number of changes which form version 3.0.1 of the Specification. These include additions to ensure ONIX 3.0 is suitable for use with East Asian writing systems and multi-language supply chains, a handful of other additions, and some deprecations intended to simplify implementation.

Please note the list of changes dated 27 Jan 2012 in the Document history below. New data elements and composites are marked ‘New in 3.0.1’ in the main body of the specification and with a dagger symbol (†) in the Data element summary. Use of data elements introduced in version 3.0.1 may require Codelists Issue 16 or later.

Introduction to Release 3.0 revision 2 (3.0.2)

This revision includes a number of new data elements which form version 3.0.2 of the Specification. These include additional elements for specifying more detailed physical stock information, new price identifiers, and additional information about licensing of digital products and locations associated with contributors. New data elements and composites are marked ‘New in 3.0.2’ in the main body of the specification, with a double dagger symbol (‡) in the Data element summary, and the changes are dated 24 Jan 2014 in the Document history below. Use of data elements introduced in version 3.0.2 may require Codelists Issue 24 or later.

There is also a new preferred method for specifying sales restrictions acting within a specific territory, and the original method is deprecated. This and other changes are covered in the associated Guide.

Introduction to Release 3.0 revision 3 (3.0.3)

This revision includes a number of new data elements and other improvements which form version 3.0.3 of the Specification. These include inter alia a new <PriceConstraint> composite for specifying various commercial terms and conditions associated with a price, new elements for minimum order quantities, star ratings for reviews and a new <Gender> element. The <Conference> composite is renamed as <Event> and broadened in scope. Collateral material in Block 2 can be targeted at particular territories, and treatment of unnamed contributors and unpriced items is improved. New data elements and composites are marked ‘New in 3.0.3’ in the main body of the specification, with a section symbol (§) in the Data element summary, and the changes are dated 25 Apr 2016 in the Document history below. Use of data elements introduced in version 3.0.3 may require Codelists Issue 33 or later.

Introduction to Release 3.0 revision 4 (3.0.4)

This revision includes additional elements and composites and other changes which comprise version 3.0.4 of the Specification. Among these improvements are a new <SupplyContact> composite within <SupplyDetail> to specify ordering, customer care, or returns authorization contacts at the supplier, an <EpubLicense> composite within <Price> for products where price constraints are in use, and additional <PricePartDescription> within <Tax> for products that have price components with varying tax rates. A key limitation on the use of <NameAsSubject> for real people or organizations is relaxed. Newly-added data elements and composites are marked ‘New in 3.0.4’ in the main body of the specification, and with a Delta symbol (Δ) in the Data element summary. Changes are dated 26 Oct 2017 in the Document history below. Use of data elements introduced in version 3.0.4 may require Codelists Issue 39 or later.

Introduction to Release 3.0 revision 5 (3.0.5)

This minor revision includes only one substantive addition – the <AVItem> composite in Block 3 – and a very small number of other minor additions. AV Item enables Block 3 to be used for detailed tables of contents for time-based media products such as audiobooks, and specifically allows timecodes for chapter starts to be included. The newly-added data elements and composites are marked ‘New in 3.0.5’ in the main body of the specification, and with a Phi symbol (Φ) in the Data element summary. Changes are dated 26 Oct 2018 in the Document history below. Use of data elements introduced in version 3.0.5 may require Codelists Issue 43 or later.

Introduction to Release 3.0 revision 6 (3.0.6)

This revision includes only two minor updates – the addition of <Measure> within <ProductPart> and a change to the cardinality and attributes of <WebsiteLink>. The newly-added data elements and composites are marked ‘New in 3.0.6’ in the main body of the specification, and with an Psi symbol (Ψ) in the Data element summary. Changes are dated 26 Apr 2019 in the Document history below.

Introduction to Release 3.0 revision 7 (3.0.7)

This significant revision introduces a new Block 7 – Promotional event detail – into ONIX 3.0, as well as a small number of minor updates. This is intended to enable a Product record to carry details of events such as author reading and signing tours or festival appearances promoting sales of the book. Widespread use would raise the profile of such events, and event aggregation services could notify subscribers of events in their locality.

Note that the numbering of Block 7 and its constituent Group P.27 do not follow the message order because of the block’s position between the existing Blocks 2 and 3. The newly-added block, its data elements and composites are marked ‘New in 3.0.7’ in the main body of the specification, and with a Sigma symbol (Σ) in the Data element summary. Changes are dated 31 Oct 2019 in the Document history below. Use of data elements introduced in version 3.0.7 may require Codelists Issue 47 or later.

Introduction to Release 3.0 revision 8 (3.0.8)

This revision of the ONIX 3.0 standard introduces a new Block 8 – Production detail – which is intended to allow communication of detailed specifications and source file manifests between a publisher and a technical services provider. These details can include all the information needed by the services provider to create the product itself from the components supplied – for example details of the source files, specifications for on-demand printing, transcoding and packaging parameters for audiobooks and conversion requirements for e-books. As such, Block 8 is not intended for general use right across the supply chain, and should be ignored by recipients not providing such services. However, it is intended to eliminate the need for so-called ‘sidecar files’, additional product specifications and manifests that hitherto were exchanged in parallel with ONIX data.

In message order, Block 8 and its constituent Group P.28 are positioned between the existing Blocks 5 and 6. The newly-added block, its data elements and composites are marked ‘New in 3.0.8’ in the main body of the specification, and with a Xi symbol (Ξ) in the Data element summary. Changes are dated 29 June 2021 in the Document history below. Use of data elements introduced in version 3.0.8 may require Codelists Issue 53a or later.

Document history

1 Apr 2009
Initial release (as PDF).
8 May 2009
A broken link to Code List 2 in P.3.1 has been repaired.
17 July 2009
Examples containing ampersands in P.8.12, P.19.4, P.20.12, P.21.14 and P.24.9 have been clarified with respect to the XML representation of the symbol &.
In P.3.1, the short tag for <ProductComposition> has been corrected to read ‘<x314>’.
In P.3.13, a reference to <MeasureTypeCode> has been corrected to read ‘<MeasureType>’.
In P.4.5 and P.4.6 the code list links have been corrected.
The rules expressed in the text introducing the <ProductPart> composite, and in P.4.12 and P.4.13, have been adjusted to allow <NumberOfCopies> to be sent without a <ProductIdentifier> if no identifier is available.
After P.5.13 and P.6.8, an ‘End of title element composite’ strapline has been added.
In P.7.48, the Format definition wrongly gave the impression that the element could carry multiple region codes: in fact it is intended only for a single code.
The ‘End of title detail composite’ strapline after P.8.18 has been corrected.
Following P.11.4, errors in the short tag version of the second example of the <Extent> composite have been corrected.
In P.14.3, a reference to <OtherText> has been corrected to read ‘<TextContent>’.
In P.15.1, multiple errors resulting from cut-and-paste have been corrected.
Immediately before P.16.7, an error in the first sentence of the text describing the <ResourceVersion> composite has been corrected.
In P.16.7, the short tag for <ResourceForm> has been corrected to read ‘<x441>’.
In P.16.9, a reference to ‘free text in <FeatureValue>’ has been corrected to read ‘free text in <FeatureNote>’.
In P.16.11, the text has been corrected to read ‘Mandatory in each occurrence of the <ResourceVersion> composite’.
In P.18, in the <Contributor> composite, references to elements P.8.19 to P.8.66 have been corrected to read ‘P.18.19 to P.18.66’.
In P.18, in the <RelatedWork> composite, references to ‘supporting resource’ have been corrected to read ‘related work’.
Immediately before P.20.7, the wording describing the <CopyrightStatement> composite has been corrected.
The ‘End of related material composite’ strapline after P.23.4 has been corrected.
In P.26.1, the text has been corrected to read ‘Mandatory in each occurrence of the <Supplier> composite’.
Following P.26.1, in the text introducing the <Supplier> composite, a reference to <SupplyDetail> has been corrected to read ‘<Supplier>’.
Immediately before P.26.9, in the description of the <Website> composite, a reference to <SupplyDetail> has been corrected to read ‘<Supplier>’.
After P.26.11, an ‘End of supplier composite’ strapline has been added.
On the last page of P.26, errors in the data element number ranges have been corrected.
21 Sept 2009
In H.15, added reference to ISO 8601, on which the date/time format is based.
Immediately after P.3.14, the examples have been corrected so that the short tag for <MeasureType> is now shown as ‘<x315>’.
In P.9.1, the short tag for <EditionType> has been corrected to read ‘<x419>’.
In P.20.3, the short tag for <PublishingDateRole> has been corrected to read ‘<x448>’, and the Code list link has been corrected so that it now specifies List 163.
18 Nov 2009
In H.15, clarified the range of date/time options supported in the schema.
In P.3.1, the code value in the example has been corrected.
In P.7.39, the suggested maximum length has been changed to 200, to be consistent with the <CorporateName> element.
In P.7.40, the suggested maximum length has been removed. However, in the light of recent discussion on the ONIX_Implement listserv, the future usefulness of these suggested lengths is likely to be reviewed.
22 Dec 2009
In the examples following P.3.14, and in the text above relating to corrections issued in September, the reference name <MeasureUnit> has been corrected to read ‘<MeasureUnitCode>’.
In the examples in P.5.7 and P.6.2, the code value has been corrected.
In P.7.47.and P.7.48, wording has been added to clarify that there must be at least one occurrence of either or both of the <CountryCode> and <RegionCode> elements in each occurrence of the <ContributorPlace> composite.
In the example in P.19.1, the code value has been corrected.
In P.19.6, the short tag for <PublisherIDType> has been corrected to read ‘<x447>’.
18 Mar 2010
Multiple errors in P.26.15 have been corrected.
In P.16.8, the short tag for <ResourceVersionFeatureType> has been corrected to read ‘<x442>’.
18 May 2010
The text describing P.7.14 has been amended to indicate that the Key Name(s) element is required if name part elements are used to represent a person name.
An error in the example in P.25.13 has been corrected.
29 Oct 2010
Missing short tags have been inserted in P.1.5 and P.5.3.
Notes on P.16.9 have been expanded to include a link to Code List 178.
New <ROWSalesRightsType> element has been inserted in P.21.10, the example of the use of <SalesRights> composite corrected (to incorporate both the <ROWSalesRightsType> element and the <Territory> composite), and the remainder of elements in P.21 renumbered. Reference to the <ROWSalesRightsType> element has been added in the introductory text to P.21.
Description of cardinality of <SupplyDetail> and <Supplier> has been changed, so the former is repeatable and the latter non-repeatable.
Added new <CorporateNameInverted> element at P.7.20. Note this new element may also be used within the <AlternativeName> and <NameAsSubject> composites. Remainder of P.7 elements renumbered, revised P.7 introductory text. Renumbering of P.7 affects numbering of several other parts of the document.
Modified <DateFormat> and <Date> elements within various composites carrying dates at P.7.36, P.14.8, P.15.10, P.16.13, P.20.4, P.25.14, P.26.19, P.26.75, to incorporate reference to the dateformat attribute, and to deprecate <DateFormat>. Also modified <ConferenceDate>, <CopyrightYear>, <StartDate>, <EndDate>, <ExpectedDate> and <ReissueDate> to use the dateformat attribute. The attribute may take a range of values from List 55.
Made <NameType> optional within <NameAsSubject>.
Added ability to carry <ProductForm> and <ProductFormDetail> codes at P.23.5 and P.23.6 within <RelatedProduct>. Note that these elements should not normally be included in a <RelatedProduct> composite, but may optionally be included if required by a specific recipient.
Made P.23.1 <ProductRelationCode> repeatable within a single <RelatedProduct> composite, where the related product has multiple types of relationship to the product described in the ONIX record.
Removed erroneous reference to List 155 in text describing the <PublishingDate> composite.
Added new optional element <MarketPublishingStatusNote> in P.25, renumbered remaining elements within P.25.
Made the <MarketDate> composite optional within P.25. Changed <MarketDateRole> to use codelist 163 (same list as ‘global’ <PublishingDateRole>).
Added new <PriceCoded> composite to support prices expressed as discrete price points, bands or tiers rather than as currency amounts. A new Code list 179 is introduced for use with <PriceCodeType>. <PriceAmount> becomes optional. Renumbered remainder of P.26.
Deprecated use of <CurrencyZone> data element.
Added new <ComparisonProductPrice> composite to support notification of prices of comparable products. Note that this composite should not normally be included in a <Price> composite, but may optionally be included if required by a specific recipient. Renumbered remainder of P.26.
Removed references that suggest <RecordReference> should necessarily be a number, and increased the suggested maximum data size for this element.
Clarified that a contributor’s primary name is the name used on the product, and any alternative name merely provides additional information (eg if the book is written under a pseudonym, where the real identity of the author is well-known, the primary contributor name should be the pseudonym and the real name of the contributor may be provided as an alternative name).
In P.12.6, <SubjectHeadingText>, increased the suggested maximum data length from 100 to 250 characters, to account for the possibility of supplying long semicolon-separated lists of keywords (ie where <SubjectSchemeIdentifier> is 20).
Clarified that XHTML is enabled in the <SalesRestrictionNote> element P.24.10.
Deprecated the <Complexity> composite in favor of incorporating Lexile measures in the <Audience> composite. No other schemes had been identified for use within <Complexity>.
Minor correction to example of simple <Header> composite.
Corrected error in description of the <RegionsExcluded> element in P21.5: it may only occur if <CountriesIncluded> is present.
25 Nov 2010
Corrected <x408> to <x406> in <MarketPublishingStatusNote>.
Corrected format note for <PriceCode> to refer to <PriceCodeType>.
6 Jan 2011
HTML format with enhanced content.
Note this is draft HTML5, and does not display correctly in all browsers. Added notes on Copyright page indicating browser compatibility, and the need for Unicode font support.
Added navigation behavior so that a click on any heading links to the parent section, and multiple clicks eventually return to the Table of Contents. Shift-click returns immediately to the Table of Contents, and on most headings, alt-click switches to the equivalent heading in the related Implementation and Best Practice Guide.
Added note on requirement to contact EDItEUR before translation or other localization.
Added explicit cardinality statements and valid attributes in descriptions of composites and data elements. These were previously only available in the ONIX for Book: Product Information Format Data Element Summary.
Added element tags to examples. The choice of reference name or short tag on any particular example is not meaningful – they are interchangeable, excepting that they cannot be mixed within any one ONIX message. Some element examples illustrate the use of appropriate attributes.
Added explicit links to codelists. Codelist HTML documents must be in ‘codelist’ folder in the same location as this document.
Added examples illustrating use of <ProductIdentifier>, <Barcode>, <ProductFormFeature>, <EpubTechnicalProtection>, <ProductClassification, <NameIdentifier>, <Website>, <Language>, <AncillaryContent>, <Subject>, <NameAsSubject>, <Audience>, <Prize>, <SupportingResource>, <CitedContent>, <Imprint>, <Publisher>, <SalesRestriction>, <RelatedWork>, <RelatedProduct>, <DiscountCoded>, <PriceCoded> composites; extended existing examples using <Header>, <ProductPart>, <TitleDetail>, <Contributor>, <Extent>, <SalesRights>, <Price> composites.
Added diagrams illustrating inclusion/exclusion of Countries, Regions within <SalesRights>, sequencing of <PublishingStatus> and <ProductAvailability> codes. Note these diagrams use embedded SVG, and will show only in very modern browsers.
Spectacles If no ‘spectacles’ icon is visible here, the diagrams will not display.
Incorporated restructured and partly rewritten content from ONIX for Books: Product Information Format XML Technical Notes document to form Section 1.
Incorporated some content from ONIX for Books: Product Information Format Data Element Summary to form Part 1 of Section 5 Appendix.
Incorporated revised and extended content from ONIX for Books: Product Information Format Annotated Sample Message document to form Part 2 of Section 5 Appendix.
Added sorted lists of tags in Part 3 of Section 5 Appendix.
Other minor editorial corrections and additions for clarity and style.
14 Apr 2011
Extended suggested max length of <ProductFormFeatureDescription> from 100 to 500 characters, to ensure adequate capacity for EU Toy Safety warning wording.
15 May 2011
Minor correction to numbering of elements of <Contributor> composite within Group P.5. <NoCollection/> becomes P.5.64 instead of P.5.62.
Corrected two references to <ReligiousTextID> to <ReligiousTextIdentifier>.
13 July 2011
Corrected allowed formats for datestamp attribute and <SentDateTime> element.
Corrected cardinality for <Percent> element.
Corrected one reference to <PersonNameIdentifier> to <NameIdentifier>.
Clarification that <EpubUsageConstraint> can be used even if product does not enforce constraints through technical protection.
Added note about use of a BOM in UTF-16.
15 Oct 2011
Corrected cardinality of <KeyNames> – it is only mandatory if other structured name elements are used.
Change of namespace for ONIX 3 (see Using Release 3.0 schemas for validation).
27 Jan 2012
Version 3.0 revision 1.
Removed legacy limitation to ASCII character set in elements within <Header>.
Added new collationkey attribute, attached to data elements within <TitleElement> and <Contributor> composites, to carry phonetic or other non-alphabetic sorting information.
Added new textscript attribute, attached to data elements within the <AlternativeName> composite, to carry transliterated names.
Added two notes in X.13 and X.14 about XHTML <ruby> markup and Unicode interlinear annotation delimiters for East Asian writing systems.
Added new <CollectionSequence> composite in Group P.5, for sequential ordering of products within collections.
Added <ContributorStatement> within Group P.5 for consistency with Group P.7.
Added new <SequenceNumber> element within <TitleElement> composite in Groups P.5 and P.6, to provide an explicit preferred display order for parts of a title.
Added new <TitleStatement> element in Group P.6, to provide a title for display purposes (only) when concatenation of the title elements may not be adequate.
Added new <ProductContact> composite in Group P.19, and in P.25, for per-product contact details.
Changed data format of <SubjectSchemeIdentifier> from two digits to two alphanumeric characters, to allow more than 100 subject schemes.
Changed data format of sourcename attribute, <SenderName>, <AddresseeName> to increase suggested maximum length of text to 50 characters.
Modified <ThesisYear> to take dateformat attribute.
Inserted reference to EU Toy Safety hazard warnings and e-publication accessibility in <ProductFormFeatureValue>.
Deprecated the entire <Reissue> composite in Group P.26, in favor of providing reissue information and collateral material in the main body of the Product record – for example, providing collateral material within Block 2 with an appropriate <ContentDate>.
Deprecated <AudienceCode> in Group P.13, in favor of providing the same information within the <Audience> composite.
Deprecated <PromotionContact>, <TelephoneNumber>, <FaxNumber> and <EmailAddress> data elements in Group P.25, in favor of using the <ProductContact> composite.
Improvements to the Data element summary Appendix: added hyperlinked data element numbering, flagged XHTML-enabled data elements, corrected spelling of <BibleTextOrganization> and P.18 <titleelement> tags.
Corrected description and cardinality of <CountryCode> and <RegionCode> elements within Group P.7.
Added language attribute to <MessageNote> and <AudienceCodeTypeName>.
Modified cardinality of <MessageNote>, <DeletionText>, <ProductFormFeatureDescription>, <ProductFormDescription>, <BiographicalNote>, <ContributorDescription>, <ProfessionalPosition>, <WebsiteDescription>, <ContributorStatement>, <EditionStatement>, <ReligiousTextFeatureDescription>, <IllustrationsNote>, <AncillaryContentDescription>, <SubjectHeadingText>, <AudienceDescription>, <Text>, <FeatureNote>, <CitationNote>, <PublishingStatusNote>, <SalesRestrictionNote>, <MarketPublishingStatusNote> and <PriceTypeDescription>, to allow supply of textual metadata in multiple languages ‘in parallel’ within a single Product record.
Corrected short tags in examples in X.14 and X.15 from <text> to <d104>.
24 Feb 2012
Added keywords into example record.
Clarified relationship between <TitleText>, <TitlePrefix> and <TitleWithoutPrefix>.
Corrected spelling of ‘identifer’ to ‘identifier’ in some tag names.
25 Apr 2012
Added ISNI example, and added ISNI to sample record.
Corrected documented cardinality of <CopyrightStatement> (it is repeatable).
3 Aug 2012
Corrected example showing use of <Imprint> composite.
Corrected typos in P.7.8 and after P.26.16, and aligned the example for <ProductIdentifier> with best practice.
Corrected <CollectionIdentifierType> tagname to <CollectionIDType> in appendix.
19 Oct 2012
Corrected example showing positive indication of no barcode.
19 Mar 2013
Corrected typos in heading of P.7.6, and in attributes for P.5.13a within A.1.
19 July 2013
Corrected typo in format of P.1.7.
24 Jan 2014
Version 3.0 revision 2.
Added <EpubLicense> composite for digital product licensing.
Added <LocationName> within <ContributorPlace> (and renumbered P.5.63a to P.5.63b), to associate a contributor with a town or city.
Added <NoPrefix/> empty element to indicate positively that titles have no prefix, and modified sample message.
Added <PrizeStatement> within <Prize>, to allow use of exact terminology for each prize.
Added <CopyrightType> within <CopyrightStatement>, to allow phonogram rights to be listed.
Added <SalesRestriction> within <SalesRights>, and deprecated <SalesRestriction> in previous location within <PublishingDetail>, to clarify that restrictions operate within territories.
Added <SupplierCodeTypeName> within <SupplierOwnCoding>.
Added <Proximity> and <Velocity>, and changed cardinality of <StockQuantityCoded>, within <Stock>, to improve stock reporting functionality.
Added <PriceIdentifier> within <Price>, for improved revenue reporting.
Added <ToQuantity> to allow more complex discounts.
Added <ProductIdentifier> within <PriceCondition>, for linked price offers.
Added <NoProduct/> for ‘empty’ delta updates.
Allowed XHTML markup in <EditionStatement> and increased maximum recommended length.
Removed deprecation from <Complexity> composite.
Deprecated use of textformat attribute on <ConferenceTheme>.
Changed cardinality on <PromotionCampaign>, <InitialPrintRun>, <ReprintDetail>, <CopiesSold>, <BookClubAdoption>, <PrizeName>, <ListName>, <SourceTitle> to allow repeats in parallel languages.
Added language attribute to <SourceTitle>, <PartNumber>, <ImprintName>, <CityOfPublication>, <ConferencePlace> and contributor name elements, and added textscript elements to publication title elements, to improve consistency of treatment of various textual data elements.
Added further notes on specific versions of e-publication file formats.
Added notes on use of HTML 5.
Clarified the required format for <YearOfAnnual>.
Corrected a statement about inclusion of smart quotes in the Latin‑1 character set and a small number of minor typos.
17 Feb 2014
Corrected typos – fixed spelling of <titleelement> in A.1.
29 Mar 2014
Corrected documented cardinality of <AgentRole> in P.25.1 (it is mandatory).
21 Aug 2014
Corrected link to List 220 in P.3.5.
24 Jan 2015
Changed reference to removing the xmlns attribute on <ONIXMessage> for DTD validation.
Added note in P.26.62 to clarify that a zero <PriceAmount> is not valid.
Added reference to Acknowledgement Message specification.
25 Apr 2016
Version 3.0 revision 3.
Added <ProductPackaging> to <ProductPart>.
Added <Prize> to <Contributor>, to support ‘body of work’ prizes.
Added <Gender> to <Contributor>, to support ISNI registrations.
Restructured <UnnamedPersons>, so an anonymous author can have a name identifier or an alternative name. The previous structure is deprecated.
Added <Event> as an alternative to <Conference>. The latter is now deprecated.
Added <AlternativeName>, <SubjectDate> and <ProfessionalAffiliation> within <NameAsSubject>, to improve discoverability.
Added <Territory> within <TextContent>, <CitedContent> and <SupportingResource>, to support market-specific collateral material.
Added <ReviewRating> within <TextContent> and <CitedContent>, to support structured star ratings for reviews.
Added <RelatedProduct> within <ContentItem>, to improve support for citations.
Added new <Funding> composite within <Publisher> to support tracking of grants and awards for open access publishing.
Added elements for specifying minimum order quantities.
Added <ReturnsNote> in <Supplier>, for special returns instructions.
Added <PriceConstraint> within <Price>, to support contractual terms and conditions such as library lending limits as part of a particular commercial offer.
Added <UpricedItemType> within <Price>, to support products which are available both priced and unpriced from the same supplier.
Added new <ProductIdentifier> composite within <Tax> to support German tax requirements.
For consistency, changed cardinality on <LocationIdentifier> and <LocationName> within <Stock> to allow parallel identifiers and multi-language place names, added language attribute to cited content and supporting resource links.
Documented restrictions on positive and positive or zero numbers in numeric fields, in line with notes published Jan 2015.
Increased suggested maximum length for elements within <Territory>, <SubjectHeadingText>.
Clarified semantics of datestamp attribute.
24 May 2016
Corrected minor typos, fixed reference to <PublishingRole> in <Funding> composite, and added a sentence clarifying use of <UnpricedItemType> within <Price> composite.
16 Aug 2016
Corrected typo in definition of <UnpricedItemType>.
11 Nov 2016
Noted incompatibility between embedded HTML and XSLT processing in X.15.
14 July 2017
Fixed error in change history for Sept 2009, corrected two links in Appendix A.1, minor clarification of wording in <Tax>.
26 Oct 2017
Version 3.0 revision 4
Added <SupplyContact> within <SupplyDetail> to support multiple contacts at the supplier organization.
Added <PricePartDescription> within <Tax>, to support French tax requirements.
Added <EpubTechnicalProtection> and <EpubLicense> within <Price>, to specify DRM and licenses that form a part of a particular commercial offer; renumbered existing <PriceConstraint> P.26.44a–d to P.26.44b–e.
Modified allowed format of <CollectionSequenceNumber> to support more flexible collection ordering.
Added <Reserved> within <Stock> to support frozen stock quantities.
Added <Language> within <ContentItem> to support chapters in different languages.
<ContributorStatement> and <NoContributor/> also added in <ContentItem>, and <NoContributor/> in <Collection>.
Clarification that <NameAsSubject> can be applied to names of fictional characters.
26 Oct 2018
Version 3.0 revision 5
Added <AVItem> in Block 3 to support chapter-level audio timecodes.
Added <PalletQuantity> in Block 6. Renumbered P.26.41a–c to 41b–d.
Added <TaxExempt/> as an empty element in <Price>. Renumbered P.26.70a to 70b.
In block updates (only), Blocks 2, 3, 5 may now be empty.
Corrected documented cardinality of <SalesOutletIdentifier> in P.24.
Minor updates of wording to clarify how particular composites should be repeated.
24 Dec 2018
Corrected documented cardinality of P.25.9.
26 Apr 2019
Version 3.0 revision 6
Added <Measure> within <ProductPart> in Block 1.
Revised cardinality of <WebsiteLink> within the <Website> composite.
31 Oct 2019
Version 3.0 revision 7
Added <PromotionalEvent> within a new Block 7, Group P.27.
Added <ProductClassificationTypeName> within <ProductClassification>.
Added <TextSourceDescription> in <TextContent>.
Added a region code element in <Language> and <Prize>.
Allowed XHTML markup in <PrizeStatement> and increased maximum recommended length.
Modified <ImprintName>, <PublisherName>, <SupplierName>, <AgentName> to allow a collationkey attribute.
Modified cardinality of <CopyrightYear>.
29 June 2021
Version 3.0 revision 8
Added <ProductionManifest> within a new Block 8, Group P.28.
Added <TelephoneNumber> in <ProductContact>, <SupplyContact>, <Sender> and <Addressee>.
Added <AudienceHeadingText> in <Audience>.
Added Supporting resources in <PromotionalEvent>.
Added sample Block update message in Appendix A.2.
Other minor updates of wording for clarification.
20 Aug 2021
Added note about URL-encoding to <ResourceLink>, <WebsiteLink> etc.
6 Jan 2022
Minor corrections to some headings.
3 Aug 2022
Minor corrections to cardinality of some Block 8 composites in Appendix A.1.
Clarification of text around <AudienceCodeValue> and <AudienceHeadingText>, corrected documented cardinality of <AudienceCodeValue>.

ONIX for Books message

High-level structure and conformance

ONIX for Books is a standard data format based on XML, used primarily to convey information about book and book-related products between computer systems.

An ONIX for Books Product Information Message can be regarded as having four component parts: the start of message, whose format and content is dictated by the XML standard; a message header block; the body of the message describing a number of products; and the end of message.

The start and the end of message are described in Sections X.1 and X.2.

The message header carries a number of data elements, specifying the sender and date of message (mandatory), the addressee (optional), and optionally stating message default values for language, price type, and currency. For further details, see Section 3. ONIX for Books message header in this document.

The body of an ONIX for Books Product Information Message normally consists of one or more Product records, with no theoretical limit on the number of records. Each Product record consists of some identifiers for the record and for the product it describes, plus six blocks of information – each of which is optional, and one of which may be repeated if the product is available in several different markets. There are blocks dedicated to describing the product itself, to marketing collateral, to publishing details and territorial rights, etc.

The content and format of the Product record are detailed in Section 4. ONIX for Books Product record in this document.

Many data elements within an ONIX for Books Product Information Message take their content from code lists, controlled vocabularies, to ensure common understanding of the data where message creator and recipient need not be in direct contact, and where they may operate in quite different markets. These code lists also form an integral part of the specification of an ONIX for Books message. Code lists are revised from time to time to add new codes. Old codes are never deleted, though they may be deprecated. The earliest release of the code lists that may realistically be used with this Specification is Issue 12, but for many elements marked as ‘New in 3.0.1’, ‘New in 3.0.2’ etc a later issue is required:

  • for full use of elements and composites marked ‘New in 3.0.1’, Issue 16 or later may be required;
  • 3.0.2 may require Issue 24;
  • 3.0.3 may require Issue 33;
  • 3.0.4 may require Issue 39;
  • 3.0.5 or 6 may require Issue 43;
  • 3.0.7 may require Issue 47;
  • 3.0.8 may require Issue 53a or later.

An overriding requirement is that an ONIX for Books Product Information Message must conform to the XML standard, ie it must be well-formed XML. It is also a requirement that ONIX messages are valid according to the associated RNG and XSD schemas (which are equivalent, excepting that the XSD schemas implement a number of uniqueness constraints that are not implemented in the RNG schema).

Previous releases of the ONIX for Books Product Information Message were supported by formal definitions in two schema formats: DTD and XSD. From Release 3.0, EDItEUR is maintaining formal definitions in three schema formats: RNG, XSD and DTD. The RNG and XSD formats differ from the DTD format in that they make extensive use of formal specifications of the code lists, whereas the DTD format makes almost no use of the code lists. Validation using the DTD is not sufficient and not recommended, as data element code values cannot be validated by this method. Implementers are free to choose which of the ONIX for Books schemas to use in validating the ONIX messages that they create or receive, but if the DTD format is chosen, implementers will need to find other methods for checking that all code values are valid.

Each schema is available in two separate ‘flavors’ with differing but equivalent XML markup, and any message must choose one or other markup flavor – either Reference names or Short tags. The former means that message filesizes are larger, but messages are more easily human-readable. Flavors must not be mixed within any one message. Implementers may choose to implement either or both markup flavors, and best practice guidelines within any ONIX community may guide that choice. An XSLT script available from EDItEUR can be used to convert messages from one flavor to the other.

Finally there are both implicit and explicit business rules within the Specification. Many of these cannot be enforced through validation, though some can be checked using an enhanced or ‘strict’ XSD that EDItEUR also maintains.

All implementers are expected to check that all requirements of the ONIX for Books Product Record specification are met, irrespective of whether or not these requirements are formally specified and enforced by any of the schemas. In particular, the specification defines requirements such as presence or absence of certain XML elements based on data values elsewhere in the message. These ‘business rule’ requirements cannot be specified in RNG, ‘classic’ XSD or DTD schema languages. They may or may not be encoded and enforced in an advanced schema language (eg ‘strict’ XSD v1.1, Schematron) in the future.

Your attention is drawn to the terms and conditions of use which appear in the ONIX for Books schemas themselves, in the EDItEUR licence (DOI:10.4400/nwgj) and on the copyright page of this Specification.

The DTD format is defined by the XML Standard itself: W3C Recommendation Extensible Markup Language (XML) 1.0 (Fifth Edition) – see http://www.w3.org/TR/xml/ for more details.
The XML Schema Definition (XSD) format is defined by W3C Recommendation XML Schema Part 1: Structures (Second Edition) – see http://www.w3.org/TR/xmlschema-1 for more details.
The advanced XSD v1.1 format is defined by W3C Recommendation XML Schema Definition Language (XSD) 1.1 Part 1: Structures – see http://www.w3.org/TR/xmlschema11-1/.
The RELAX NG (RNG) format is defined by ISO/IEC 19757-2:2008, published by ISO, Geneva.
X.1 Start of message

The start of an ONIX for Books message must consist of, as a minimum, two lines of XML as shown:

using Reference names
<?xml version="1.0"?>
<ONIXMessage release="3.0">Upper case ‘M’
using Short tags
<?xml version="1.0"?>
<ONIXmessage release="3.0">Lower case ‘m’

The XML declaration line may additionally declare a character encoding. Further details of this are given in the Character sets and special characters section below.

The <ONIXMessage> line may additionally declare an XML namespace attribute. Further details of this are given in the Using Release 3.0 schemas for validation section below. Both character encoding declaration and namespace attribute are recommended.

For the purposes of validation of an ONIX message against one of the schemas it may be necessary to insert some additional information, to include an explicit reference to the schema against which to validate the message. The precise XML that needs to be inserted will depend upon the schema format and the tools being used for validation. Further details of this are also given in the Using Release 3.0 schemas for validation section below. For communication purposes it is recommended that all such schema references be omitted from the message, as the recipient will frequently need to use a different version of the schema and different tools for validation to those used by the originator.

X.2 End of message

The end of message ‘trailer’ must consist of a single line as shown:

using Reference names
</ONIXMessage>Upper case ‘M’
using Short tags
</ONIXmessage>Lower case ‘m’
X.3 Layout of a complete message

In summary, the layout of a typical ONIX for Books Product Information Message is like this:

using Reference names
<?xml version="1.0"?>Start of message
<ONIXMessage release="3.0">
<Header>Header
        <!-- message header data elements -->
</Header>
<Product>Body
        <!-- record reference for product 1 -->
        <!-- product identifiers for product 1 -->
        <!-- block 1 product description -->
        <!-- block 2 marketing collateral detail -->
        <!-- block 7 promotion detail -->
        <!-- block 3 content detail -->
        <!-- block 4 publishing detail -->
        <!-- block 5 related material -->
        <!-- block 8 production detail -->
        <!-- block 6 product supply -->
</Product>
<Product>
        <!-- record reference for product 2 -->
        <!-- product identifiers for product 2 -->
        <!-- data blocks for product 2 -->
</Product>
<!-- further product records… -->
<Product>
        <!-- record reference for product n -->
        <!-- product identifiers for product n -->
        <!-- data blocks for product n -->
</Product>
</ONIXMessage>End of message
using Short tags
<?xml version="1.0"?>Start of message
<ONIXmessage release="3.0">
<header>Header
        <!-- message header data elements -->
</header>
<product>Body
        <!-- record reference for product 1 -->
        <!-- product identifiers for product 1 -->
        <!-- block 1 product description -->
        <!-- block 2 marketing collateral detail -->
        <!-- block 7 promotion detail -->
        <!-- block 3 content detail -->
        <!-- block 4 publishing detail -->
        <!-- block 5 related material -->
        <!-- block 8 production detail -->
        <!-- block 6 product supply -->
</product>
<product>
        <!-- record reference for product 2 -->
        <!-- product identifiers for product 2 -->
        <!-- data blocks for product 2 -->
</product>
<!-- further product records… -->
<product>
        <!-- record reference for product n -->
        <!-- product identifiers for product n -->
        <!-- data blocks for product n -->
</product>
</ONIXmessage>End of message
Note the use of multiple Product records (from <Product> to </Product>). The number of Product records in a message may vary from one to many thousands, and a message with no Product records (but with a <NoProduct/> tag – see X.4 below) is also possible.
Note also that ONIX messages can contain XML comments, introduced with ‘<!--’ and terminated with ‘-->’. Comments may be helpful during development, when data may have to be checked ‘by eye’. However, they are of no significant benefit in production, as they should be ignored by automated XML processing systems.
X.4 Empty XML elements

There are a very few elements in the ONIX for Books format which are defined as empty elements in XML, and whose function is to act as ‘flags’ which may be either present or absent. These elements do not carry any data content. An example in ONIX 3.0 is the <MainSubject/> element, used to flag a <Subject> composite to show that it represents the primary subject of a product (within any one particular subject classification scheme).

All other elements are defined as carrying data content, and must not be sent as empty elements. If an element is mandatory, data content must be supplied, or the message will be invalid. If an element is optional, and there is no content for it, it must be omitted entirely. These rules are enforced in the RNG and XSD schemas, but cannot be enforced by the DTD.

An exceptional empty element is <NoProduct/>. The sole valid use of this is to denote an ‘empty message’ within a stream of updates sent on a prearranged timetable, providing a positive indication that there have been no changes since the previous update:

using Reference names
<?xml version="1.0"?>
<ONIXMessage release="3.0">
<Header>
        <!-- message header data elements -->
</Header>
<NoProduct/>
</ONIXMessage>
using Short tags
<?xml version="1.0"?>
<ONIXmessage release="3.0">
<header>
        <!-- message header data elements -->
</header>
<x507/>
</ONIXmessage>

Another exceptional group consists of the five ‘empty blocks’: <CollateralDetail/>, <PromotionDetail/>, <ContentDetail/>, <RelatedMaterial/> and <ProductionDetail/> may only be empty within a partial ‘block update’ (see P.1.2) where the intention is to ‘reset’ or delete any previously supplied collateral material, promotional event detail, content detail, links to related products and works, or production manifest detail. The other blocks <DescriptiveDetail>, <PublishingDetail> and <SupplyDetail> contain mandatory elements and cannot be empty in any circumstances – though the blocks can be omitted entirely within block updates.

Note that in all cases, the XML ‘self-closing’ syntax is recommended for all empty elements and blocks (ie <NoProduct/> rather than <NoProduct></NoProduct>).

Use of XML attributes

In all ONIX applications, a number of XML attributes may be used where applicable to carry information about the content of an associated element. The view which has been taken in the development of ONIX is that it is undesirable to use XML attributes to carry portions of the actual data content of the ONIX message. However, it is appropriate to use them to carry information which qualifies the data itself and its representation – metadata about metadata, as it were.

Accordingly, a number of general attributes are defined in ONIX for Books. Three attributes may be used with any ONIX element, and they are not noted individually for each data element in the specification:

  • datestamp
  • sourcename
  • sourcetype

Further attributes may be used with a limited selection of data elements, as noted individually for each element in the specification:

  • collationkey
  • dateformat
  • language
  • release
  • textcase
  • textformat
  • textscript

Attributes are carried within an XML start tag. The attribute name is lower case, separated from the name of the element by a space, and the attribute value is placed in double quotes. If there are two or more attributes in a single tag, they too are separated by a space. Multiple attributes in a single tag may occur in any order.

The built-in XML attributes xml:lang and xml:space are not used in ONIX for Books: these attributes are available by default in all XML applications, and cannot be prohibited technically, but should never be included in ONIX messages.

X.5 Datestamp attribute

Enables any data element or composite to carry the date or date and time when it was last updated or confirmed as correct (for example when it is not managed directly within the message sender’s system and the ‘age’ of the data is significantly older than the remainder of the message).

The attribute indicates the currency of the data, not necessarily when it was last changed. If not supplied, there is no default value, and recipients should assume that un-datestamped data is current at the time the message was sent. Data recipients should if necessary identify recently-changed data elements by comparison with any data previously supplied. If used on a composite, the datestamp indicates the most recent date when any individual data element within the composite was updated or confirmed as correct.

The datestamp attribute is particularly useful on frequently-changing data such as price, stock quantities and availability, and in circumstances where an ONIX recipient may receive data from varying sources, in order that they may select the most current data.

Permitted formats, where ‘T’ and ‘Z’ represent themselves (ie the letters T and Z), and where the symbol ‘±’ represents either ‘+’ or ‘-’ to indicate a timezone offset from UTC.
YYYYMMDDDate only
YYYYMMDDThhmmDate and time (local time of sender)
YYYYMMDDThhmmZUniversal time (UTC) †
YYYYMMDDThhmm±hhmmWith time zone offset from UTC †
YYYYMMDDThhmmssDate and time (with seconds)
YYYYMMDDThhmmssZUniversal time (with seconds)
YYYYMMDDThhmmss±hhmmWith time zone offset from UTC (with seconds)
† indicates the preferred formats
datestamp
<CopiesSold datestamp="20100621">6400 copies of this edition sold</CopiesSold> (Sales figure last confirmed June 2010)
The calendar date must use the Gregorian calendar, even if other dates within the message use a different calendar. For practical purposes, UTC is the same as GMT.
X.6 Sourcename attribute

Enables a data element or composite to carry the name of the source or authority for the data content. This is particularly useful when an ONIX record is issued based on information received from another party (eg a wholesaler passing information received from a publisher or distributor to a retailer). If not supplied, the data authority should be assumed to be the sender of the ONIX message.

Variable length text, suggested maximum 50 characters
sourcename
<x313 sourcename="XYZ Livres SA">01</x313> (XYZ is source of information)
X.7 Sourcetype attribute

Enables a data element or composite to carry a code indicating the type of source or authority for the data content. This is particularly useful when an ONIX record is issued based on information from another party (eg a wholesaler passing information received from a publisher or distributor to a retailer). If not supplied, the data source should be assumed to be the sender of the ONIX message.

Fixed length, two digits
List 3
sourcetype
<x313 sourcetype="01">01</x313> (Source of information is publisher)
X.7a Collation key attribute

Enables a data element to carry the key to be used for sorting, when the sort order is not inherent to the data itself. For example, with Chinese or Japanese contributor names, the collationkey attribute may carry phonetic information required to sort records by contributor.

Variable length text, suggested maximum 50 characters
collationkey
<b037 collationkey="むらかみはるき">村上春樹</b037>
X.8 Dateformat attribute

Used with a range of date elements to specify the format of the date. Each data element on which this attribute may be used specifies a default dateformat if the attribute is not supplied – for most date elements, this is format ‘00’, YYYYMMDD. In some cases, the format of the date may be described via a <DateFormat> data element instead, but this is deprecated. If dateformat and <DateFormat> are both supplied, <DateFormat> should be ignored.

Fixed length, two digits
List 55
dateformat
<Date dateformat="03">20104</Date> (Calendar quarter 4 of 2010)
X.9 Language attribute

Enables the language of any text element to be specified when it is not the expected default language of the message. The default language of the message (ie of the metadata) is generally set by agreement between sender and recipient, and is separate from (though usually identical to) the default language of the text used within the products described within the message (for the latter, see <DefaultLanguageOfText>).

Many data elements that carry the language attribute are repeatable in order to allow parallel text to be provided in multiple languages. Data recipients able to support only a single language should select the repeat that carries the most appropriate language attribute.

Generally, a language also implies a particular script. (There are a very few languages that are commonly written in more than one script.) However, names are not considered to be ‘in’ a particular language, but are commonly transliterated from one script to another, and a limited number of data elements carry the textscript attribute. These may also carry a language attribute in order that distinct transliterations that match the orthography norms of a particular language can be distinguished, cf the Cyrillic name ‘Александр Солженицын’, and the transliterations into Latin script ‘Aleksandr Solzhenitsyn’ (English), and ‘Alexandre Soljenitsyne’ (French).

Fixed length, three lower-case letters. Note that ISO 639 specifies that these codes should always be in lower-case
ISO 639-2/B List 74
language
<TitleText language="fre" textcase="01">Les misèrables</TitleText> (Title is in French [and in sentence case])
X.10 Release attribute

From ONIX for Books Release 3.0, identifies the release of the ONIX format standard to which the message conforms. Used only in the top-level element <ONIXMessage> (short tag <ONIXmessage>), and is mandatory. The value will change with each new release, so that all messages will show explicitly the release to which they are intended to conform.

must be “3.0” for this release
release
<ONIXmessage release="3.0">
X.11 Textcase attribute

Enables the case of the text of a title or subtitle to be specified. If not supplied, the default value is ‘00’, indicating the case is Undefined.

Fixed length, two digits
List 14
textcase
<TitleText textcase="03" language="spa">MÉXICO EN LA OBRA DE OCTAVIO PAZ</TitleText> (Title is all upper case [and in Spanish])
X.12 Textformat attribute

Used with a limited range of text elements that are allowed to contain formatted text, to enable the markup format such as XHTML to be specified. If not supplied, the default is ‘06’, indicating the text format is plain text in the character encoding declared in the XML declaration at the top of message, without additional markup. If the XML declaration does not specify a character encoding, the XML default character set should be assumed to be the basic ASCII characters. See the Character sets and special characters section below for further details of how a character encoding declaration is used.

Fixed length, two digits
List 34 Note only values 02, 03, 05, 06 and 07 may be used
textformat
<Text textformat="05"><p> … descriptive text … </p></Text> (Descriptive text contains XHTML markup)
X.12a Textscript attribute

Used with a limited range of text elements that are used to provide transliterated alternatives to names within the <AlternativeName> composite, and to titles.

Fixed length, four letters. Note that ISO 15924 specifies that script codes shall be sent as one upper case followed by three lower case letters
ISO 15924 four-letter script codes List 121
textscript
<PersonName textscript="Latn">Daniel Domscheit-Berg</PersonName>

Using Release 3.0 schemas for validation

The main use of the ONIX for Books schemas is for making automated checks of the validity of an ONIX message: does it use the right tags and the right code values in the right place?

Prior to Release 2.1 Revision 02 there was only one official form of schema published by EDItEUR: DTDs, one for each flavor (Reference name and Short tag) of the format. It was a requirement of earlier Releases that every ONIX message used for supply chain communication purposes should include a URL pointing to the reference copy of the appropriate DTD on the EDItEUR website. From Release 2.1 Revision 02 onwards the alternative of using an XSD form of the schema for validation was available, and the DTD link could be omitted, but only by prior arrangement between the parties concerned. The DTD remained the official tool of reference for determining whether or not an ONIX message was valid.

With Release 3.0, the DTD no longer has a primary status, and implementers are free to choose between the three forms now available – DTD, XSD and RNG – according to their own implementation requirements and constraints.

The availability of the Release 3.0 schemas in three different forms means an increase in the validation options. The XSD and RNG forms are both much more expressive than the DTD form, enabling validation of code values, dates, quantities and link addresses where appropriate. The XSD and RNG forms are also easier for software developers to work with, and are therefore likely to make Release 3.0 quicker to implement. But it therefore no longer makes sense to require that all messages contain a link to a specific form of the schema on the EDItEUR website. A different approach to validation of messages is necessary.

For validation of ONIX messages against a Release 3.0 schema EDItEUR recommends that implementers adopt the following approach:

  1. Decide which form of schema to use for validation purposes;
  2. Download from the EDItEUR website a copy of the selected schema and install this copy in an accessible location on a local server (eg on a corporate intranet or on a stand-alone PC);
    • the local copy of the schema should be updated regularly to incorporate the latest issues of the codelists and any technical improvements in the schema itself;
  3. Configure the software tools used for validation purposes to refer to the local copy of the schema.

When using an XSD or RNG schema to validate ONIX messages, an appropriate xmlns namespace attribute is required in the top-level <ONIXMessage> start tag. When using a DTD, the namespace attribute is optional. If you are using Reference names, the namespace URI should be “http://ns.editeur.org/onix/3.0/reference”. If you are using Short tags, the namespace URI should be “http://ns.editeur.org/onix/3.0/short”. These namespace URIs are the same as those specified within the corresponding ONIX DTD, XSD and RNG schemas. Note that these URIs do not correspond to an actual web address that is reachable by a browser. They are simply a device for creating an unambiguous reference to the authority for the defined ONIX namespaces. Inclusion of the xmlns attribute in all messages is recommended.

using Reference names
<ONIXMessage release="3.0" xmlns="http://ns.editeur.org/onix/3.0/reference">
using Short tags
<ONIXmessage release="3.0" xmlns="http://ns.editeur.org/onix/3.0/short">

Depending on the software tools used for validation, further changes to this start tag may be necessary. For example, with some validation software it may be necessary to identify within the ONIX message the location of the .xsd file to be used for validation. This location would normally be on a local disc or internal network. The xsi:schemaLocation attribute links the ONIX namespace URI to the .xsd location, and this location would correspond to a real address reachable by a browser (from the machine doing the validation).

locating the XSD schema on an internal network
using Reference names
<ONIXMessage release="3.0" xmlns="http://ns.editeur.org/onix/3.0/reference" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ns.editeur.org/onix/3.0/reference http://intranet/onix/ONIX_BookProduct_3.0_reference.xsd">
using Short tags
<ONIXmessage release="3.0" xmlns="http://ns.editeur.org/onix/3.0/short" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ns.editeur.org/onix/3.0/short http://intranet/onix/ONIX_BookProduct_3.0_short.xsd">
The intranet location would be different for each organization’s validation scenario.

When using a DTD to validate an ONIX message, a suitable DOCTYPE declaration must be added.

Any link to a local copy of the relevant schema that has been added to an ONIX message by a sender for validation purposes – for example the xsi:schemaLocation attribute or any DOCTYPE declaration – should be removed prior to making the ONIX message available to supply chain partners. They will make their own arrangements for validation of incoming messages to suit their own internal systems. Note that the xmlns namespace attribute need not be removed.

Character sets and special characters

In principle, XML data files may include any Unicode character, and the default encoding is either UTF‑8 or UTF‑16. In practice, unless the XML declaration at the beginning of the ONIX message includes an explicit ‘encoding declaration’, you should restrict the character set to the printable characters of ASCII (ie those characters whose Unicode numbers fall between 32 and 126 inclusive). This limited character set is unlikely to be adequate for anything except the most basic data in English, so it is expected that most – and outside of the English language markets, all – ONIX messages will include an encoding declaration or other special coding of non-ASCII characters described in the Extended character sets and encoding declarations section below.

For reference, here is a list of the basic character set for which no special coding is necessary, all of which can be found on a standard English computer keyboard:

  • space character
  • capital letters A–Z
  • lower-case letters a–z
  • digits 0–9
  • punctuation ! " ' , - . : ; ?
  • brackets ( ) [ ] { }
  • symbols # $ % * + / = > \ @ _ ` | ~

The tab, line feed and carriage return characters are also allowed, but most XML software will treat them as spaces. Other ‘control characters’ (non-printing characters with an ASCII code number below 32) are not allowed.

This set deliberately does not include the characters ‘&’ and ‘<’. These characters have special significance in all XML applications, and therefore cannot be used as text characters in any ONIX data elements. If you need to include either of these characters within a data element (for example in the name of an organization such as ‘AT&T’ that by convention uses ‘&’ rather than ‘and’), you must use the XML named entity reference form of expression in place of the ‘&’ or ‘<’:

entity represents
&amp;&
&lt;<

You may also use named entity references in place of the following characters:

entity represents
&quot;"
&apos;'
&gt;>

ONIX for Books markup (XML element and composite names, attribute names, and code values drawn from the ONIX codelists) is limited to this basic set of ASCII characters, plus the literal ‘&’ and ‘<’ symbols.

Note that the currency symbols ‘£’, ‘¥’ and ‘€’ (the Pound Sterling, Yen and Euro symbols) are not in the basic set, nor are there standard named entity references that may be used in their stead. En and em rules, ellipsis and bullet characters, accented and other uncommon characters are also missing from the basic set. Note also that some office applications insert so-called ‘smart’ apostrophes and quotation marks (single or double, open or closed), and these too are not in the basic set.

If your ONIX message contains no characters beyond this basic set, then no special coding is necessary. However, without special precautions, if your ONIX message contains even a single character beyond this basic set, there is a significant risk that a recipient will reject your ONIX because it contains invalid text. This is because XML without a character encoding declaration will be assumed to use the UTF‑8 encoding – and even one extended character, for example from the Latin‑1 character set, is likely to cause a UTF‑8 text error.

X.13 Extended character sets and encoding declarations

If the basic ASCII character set is not adequate – and in most cases it will not be – there are two ways to incorporate non-ASCII characters into your ONIX data: either use Unicode numerical character references, or use an encoding declaration.

Numerical character references take the form defined in Section 4.1 of the XML 1.0 Recommendation. For example, the character ‘ž’ (z háček or z caron, used in Czech and some other languages) can be expressed as ‘&#382;’ or ‘&#x17e;’ where 382 and 17e are the Unicode character numbers in decimal and hexadecimal (base 16 numbers) respectively. In principle, any Unicode character can be included in ONIX data this way.

using a decimal character reference – é is character 233
<TitleText>Les Mis&#233;rables</TitleText> (Les Misérables)
using a hexadecimal character reference - é is character e9
<TitleText>Les Mis&#xe9;rables</TitleText> (Les Misérables)
Character references between &#127; and &#159; (or between &#x7f; and &#x9f; in hexadecimal) should never be used. It is a common error to use these numbers (eg &#158; or &#x9e; for ‘ž’), since they are valid character numbers in the Windows‑1252 character set, and they appear to work in web browsers, but they are strongly discouraged in all XML applications.

If you have a relatively small number of non-ASCII characters in your ONIX data, this approach using numerical character references might well be suitable. But beware: as above, in the absence of an encoding declaration, even a single character that is not in the basic ASCII set and not encoded into a numerical character reference can cause a text validation error.

If your ONIX data is not primarily in English, or if you make extensive use of extended characters even in English text, then it is likely to be simpler to use a message-wide encoding declaration. This must be included in the XML declaration at the beginning of the ONIX message.

<?xml version="1.0" encoding="ISO-8859-1"?> (message uses ISO Latin‑1 character set and encoding)
<?xml version="1.0" encoding="Windows-1252"?> (message uses Windows‑1252 character set and encoding)
<?xml version="1.0" encoding="ISO-8859-15"?> (message uses ISO Latin‑9 character set and encoding)

Declaring the ISO Latin‑1 character set with ISO‑8859‑1 encoding allows characters and diacritics used in most Western European languages to be included in the ONIX message without any special encoding, as well as some other extended characters. However, note that Latin‑1 does not include a ‘€’ symbol (Latin‑9 – also known as ISO‑8859‑15 – is an alternative character set that does), nor does it contain smart quotes (“ ” and ‘ ’), en and em dashes or the ellipsis character. Local circumstances may favor the use of other character sets and encodings, such as any of Parts 2 through 16 of ISO 8859, the common Windows‑1252 (which is likely to be used by many older Windows-based applications in North America and Western Europe, and which does include smart quotes, en and em dashes and the ellipsis), or various Asian language encodings such as Shift-JIS.

Alternatively, a Unicode encoding like UTF‑8 or -16 can include characters from any and all of these character sets. Despite the fact that UTF‑8, UTF‑16BE or UTF‑16LE are the ‘default’ character encodings used in all XML applications, it is strongly recommended that they are declared explicitly when it is used in an ONIX for Books message. A byte order mark should not be included in UTF encodings. EDItEUR recommends the use of UTF‑8 encoding in ONIX messages that will be exchanged outside a particular national market.

<?xml version="1.0" encoding="UTF-8"?> (UTF‑8 encoding, Unicode character set)

Using a suitable message-wide encoding means that no special encoding needs to be used for individual non-ASCII characters, making it straightforward to include metadata in any language.

<Text>« Je viens détruire la fatalité humaine, écrit Hugo, je condamne l’esclavage, je chasse la misère, j’enseigne l’ignorance, je traite la maladie, j’éclaire la nuit, je hais la haine. Voilà ce que je suis et voilà pourquoi j’ai fait Les Misérables. »</Text>

This applies equally to languages that use a Latin-based script, such as French above, and languages that use other scripts:

data in Cyrillic script
<PersonNameInverted>Достоевский, Фёдор</PersonNameInverted> (Fyodor Dostoyevsky)
data in simplified Chinese script
<PersonName>刘慈欣</PersonName> (Liú Cíxīn)
right-to-left reading data in Arabic script
<TitleText>عمارة يعقوبيان</TitleText> (Imārat Yaʿqūbīān)
1--------> <··············2 3--------->

Note that for Arabic, as above, and other scripts normally rendered right-to-left, the order of characters in the message follows the logical reading order for each script (as indicated by the arrows): that is, the letters ain and meem forming the first syllable of the book title (the ‘Im’ in ‘Imārat’) immediately follow the <TitleText> start tag in the message data, even though they are displayed right to left, starting adjacent to the </TitleText> end tag, and the last Arabic character, the letter noon (the ‘n’ in ‘Yaʿqūbīān’), is followed immediately by the end tag, even though it is displayed adjacent to the start tag.

Whichever encoding is declared, ONIX implementers need to ensure the character set and encoding are controlled throughout the process of creating the ONIX data, so that data that is declared as being, say, ISO‑8859‑1, really is encoded as ISO‑8859‑1 and does not include any characters that are not present in the Latin‑1 character set: simple cutting and pasting text from a variety of sources, for example, is likely to introduce character encoding inconsistencies (a character would be understood by the recipient as some different character entirely) and may even result in completely invalid text. Software used to create XML with a rich character set needs careful configuration.

The two methods of incorporating non-ASCII characters can be combined: if your message uses the ISO Latin‑1 character set and ISO‑8859‑1 encoding, it can include characters such as é, ø or £ ‘natively’. And although Latin‑1 does not include the ‘ž’ character, it can still be included in your data using the numerical character reference ‘&#382;’ (or the hexadecimal equivalent ‘&#x17e;’). In contrast, if you use UTF‑8, no numerical character references are necessary – effectively all characters can be included ‘natively’.

Implementers should note that it is not a requirement that recipients of ONIX messages should be able to handle correctly any character encodings other than ASCII, but supporting at least UTF‑8 as an encoding is very strongly recommended. Equally, it is not a requirement for recipients to support any characters beyond the basic ASCII set, but in practice it is expected that recipients support the characters used in the commonly-used languages and scripts in their area of operation. For further technical guidance on character encodings in XML see Section 4.3.3 of the XML 1.0 Recommendation.

In earlier releases of ONIX for Books it was recommended that named HTML entity references be used in preference to numerical character references, and these were supported by the inclusion of special named entities such as ‘&ouml;’, ‘&hellip;’ or ‘&ndash;’ in the ONIX for Books DTD. This recommendation no longer applies, and named entity references other than the five mandatory entities required for XML (&amp;, &lt;, &gt;, &apos; and &quot;) are not supported in ONIX 3.0. Special characters that are not available in the character set and encoding used for the message may only be represented by numerical character references (ie an ellipsis may be included as ‘&#8230;’ or ‘&#x2026;’, where in previous ONIX versions, ‘&hellip;’ could have been used).

For textual data in an East Asian writing system which uses text glosses (for example Chinese or Japanese), glosses should be incorporated in one of two ways. In ONIX text fields that allow the inclusion of XHTML or HTML markup (see below), glosses should be incorporated using the (X)HTML <ruby> tag. In ONIX text fields that do not allow inclusion of XHTML or HTML markup, Unicode’s interlinear annotation delimiters (numerical character references &#xfff9;–&#xfffb;) may be used to delimit the gloss.

data in Japanese kanji script, including hiragana gloss
<PersonNameInverted>&#xfff9;村上春樹&#xfffa;むらかみ はるき&#xfffb;</PersonNameInverted> (Haruki Murakami)
This should typically be displayed as 村上 春樹むらかみ はるき. Note that the interlinear annotation delimiters do not need to be included as numerical character references – they can be ‘native’ characters if the character encoding allows – but numerical references are used here for clarity because the characters are otherwise invisible. If a recipient application cannot properly process the interlinear annotations, then &#xfff9; should be ignored, and &#xfffa; should be replaced with ‘ (’ and &#xfffb with ‘) ’ for display purposes.

Using XHTML, HTML or XML within ONIX text fields

Given the frequent requirement for ONIX messages to convey rich product information in a form suitable for use in web pages, guidance is provided below on how to incorporate content intended for use on the web – or any other text with XHTML or HTML markup – in an ONIX product record. However, in order to apply this guidance correctly, a user must already have some knowledge of different forms of web content. Those already familiar with the differences between HTML and XHTML may skip this section.

Web content that is largely text-based is generally styled for presentation in a web page using the HyperText Markup Language (HTML). HTML has been the language of the World Wide Web since its inception and is still the most popular language for constructing web pages. HTML was based upon the Standard Generalized Markup Language (SGML), which has been in use for preparing electronic content in academic and professional publishing since the early 1990s.

XML was developed in the late 1990s as demand grew for ways to use the web for exchanging data and messages that didn’t have to be presented as human-readable web pages. XML is a much stricter language than SGML, so it is generally not possible to incorporate HTML-tagged content directly into an XML message. Responding to demand to make it possible to embed HTML in XML, the World Wide Web Consortium has defined an XML-compatible version of HTML, called XHTML. XHTML text fragments can be embedded in XML messages, provided this is allowed by the tagging rules of the XML application.

The tagging rules of ONIX specify that XHTML text fragments may be embedded in certain ONIX data elements, but within very strict constraints. These constraints are set out in section X.14 below, along with a list of the appropriate data elements.

HTML text fragments – and indeed any fragment of tagged text, regardless of the tagging language – can also be embedded in ONIX data elements, but only by using XML techniques that ‘hide’ these fragments from any XML-aware software that is processing the ONIX message. Two such methods for embedding HTML or other tagged text in an ONIX data element are described in section X.15 below. These methods are available by default in all XML applications, and cannot be prohibited in ONIX applications, but their use is strongly discouraged. All ONIX users are encouraged to convert HTML text fragments to be valid XHTML fragments before incorporating them in ONIX messages. In any event, these methods should only be used in, and HTML should only be embedded in, the ONIX data elements that may also be used with XHTML (and which are listed below). The range of HTML tags and attributes used should be restricted in the same way as the usable XHTML tags.

X.14 XHTML (Version 1.0 or 1.1)

The ONIX Product Information Message DTD and the XSD and RNG schemas enable the inclusion of XHTML-tagged text within specific data elements where this has been deemed appropriate. This is, for example, the expected way to include multiple paragraphs of text in long descriptive data. In these cases the data element may contain any well-formed fragment of XHTML-tagged text – the allowed set of tags is based around XHTML 1.1 with the following restrictions:

  1. It must be the case that, if the fragment were to be placed in an otherwise empty <body> element in an XHTML document, the resulting document would be valid. Ideally, all text within the fragment should be enclosed in block-level XHTML tags (for example <p> or <ul>);
  2. The fragment may not include any XHTML forms, embedded objects, or script or document revision elements;
  3. The fragment may not use ‘event’ attributes and others that may affect browser behavior;
  4. The fragment may not include special character named entity references (other than the five available to all XML applications, where literal <, >, ', " and & characters occur in the XHTML text content. Note these entities should not be used to replace XHTML markup).

The intention of the first three of these restrictions is to prevent the unwitting or malicious transmittal of viruses in ONIX messages. The intention of the fourth of these restrictions is to enable validation of ONIX for Books messages against any of the three schema formats in which the ONIX for Books schemas are available.

Note also that some ONIX recipients may be reluctant to use XHTML text that contains links, images, tables, or that uses attributes such as style. Therefore, although a wide range of tags is allowed, it is strongly recommended that XHTML tags are limited to the following set:

  • <p>
  • <strong>
  • <ul>
  • <sub>
  • <dl>
  • <ruby>
  • <br />
  • <em>
  • <ol>
  • <sup>
  • <dt>
  • <rp>
  •  
  • <b>
  • <li>
  •  
  • <dd>
  • <rb>
  •  
  • <i>
  •  
  •  
  •  
  • <rt>
  •  
  • <cite>
  •  
  •  
  •  
  •  

Use of XHTML attributes should be limited to the type and start attributes to control bullets and list item numbering with the <ol> tag used for ordered lists.

The data elements within which XHTML markup may be used are:

  • <AncillaryContentDescription>
  • <AudienceDescription>
  • <BiographicalNote>
  • <BookClubAdoption>
  • <CitationNote>
  • <CopiesSold>
  • <ConferenceTheme> (deprecated)
  • <ContributorDescription>
  • <ContributorStatement>
  • <EditionStatement>
  • <EventDescription>
  • <FeatureNote>
  • <IllustrationsNote>
  • <InitialPrintRun>
  • <MarketPublishingStatusNote>
  • <PrizeJury>
  • <PrizeStatement>
  • <PromotionCampaign>
  • <PromotionContact> (deprecated)
  • <PublishingStatusNote>
  • <ReissueDescription> (deprecated)
  • <ReligiousTextFeatureDescription>
  • <ReprintDetail>
  • <SalesRestrictionNote>
  • <Text>
  • <TextSourceDescription>
  • <TitleStatement>
  • <VenueNote>
  • <WebsiteDescription>

The use of XHTML tags within any of these data elements should be signalled by including the textformat attribute with value ‘05’ in the start tag of the data element in question:

using Reference names
<Text textformat="05"><p>XHTML-tagged text…</p><p>…may be multiple paragraphs.</p></Text>
using Short tags
<d104 textformat="05"><p>XHTML-tagged text…</p><p>…may be multiple paragraphs.</p></d104>

Note that XHTML tags such as <p> or <strong> must be properly closed, correctly nested, and must be lower case. It may be useful with self-closing elements such as <br/> to use the modified form <br /> – the extra space character makes no significant difference in XHTML, but improves compatibility if the XHTML is inadvertently used by the recipient in an HTML context.

For XHTML textual data in an East Asian writing system which uses text glosses (for example, Chinese or Japanese), the <ruby> tag should be used. Both ‘simple’ and ‘complex’ ruby from XHTML 1.1 (see http://www.w3.org/TR/ruby/) are supported by the ONIX for Books schemas, though browser support for complex ruby is not universal. Note that XHTML markup must not be mixed with Unicode interlinear annotation delimiters within a single data element.

Most of the XHTML-enabled data elements listed above are also repeatable, to provide parallel text in multiple languages – <ConferenceTheme>, within which the use of XHTML markup is strongly discouraged, and the other two deprecated elements <PromotionContact> and <ReissueDescription> are the exceptions. (<TitleStatement> appears to be an exception, but it may be repeated per language using a separate <TitleDetail> composite.) In contrast, the following data elements are repeatable for multiple languages, but are not XHTML-enabled:

  • <DeletionText>
  • <EpubLicenseName>
  • <EventAcronym>
  • <EventPlace>
  • <EventName>
  • <EventTheme>
  • <ListName>
  • <LocationName>
  • <MessageNote>
  • <PricePartDescription>
  • <PriceTypeDescription>
  • <PrizeJury>
  • <ProductFormDescription>
  • <ProductFormFeatureDescription>
  • <ProfessionalPosition>
  • <RatingUnits>
  • <ReturnsNote>
  • <SourceTitle>
  • <SubjectHeadingText>
  • <WebsiteLink>
X.15 HTML (Version 4.01 or earlier), and other XML

The inclusion of text tagged in accordance with HTML version 4.01 or earlier in an ONIX data element is possible using one of two methods described below, but use of either method is strongly discouraged – if possible, use XHTML instead. In the event that HTML is included, in either of these ways, it may only be included in the elements listed in X.14 above, and the textformat attribute on the start tag for the element should be specified with the value ‘02’ (HTML, other than XHTML). It is strongly recommended that the range of HTML tags is limited to the small set listed for XHTML above (<p>, <br />, <strong> etc).

XML-tagged text can be included in the same selection of ONIX data elements, using the same two methods. XML-tagged text should use the textformat attribute with value ‘03’ (XML).

To embed HTML or XML (other than XHTML) in an ONIX data element, either:

  1. Replace the ‘<’ character at the start of every HTML or XML start and end tag with its entity reference ‘&lt;’, or
  2. Enclose the entire content of the data element within an XML ‘CDATA section’ (see Section 2.7 of the XML 1.0 Recommendation for details of this).

In general, method 2 using CDATA is preferred to method 1.

Note: using embedded HTML markup with either method presents significant difficulties for data senders and recipients who process the ONIX data using XSLT. Any named character entities encapsulated within CDATA will make the ONIX invalid after processing, since XSLT processing cannot output ONIX using method 2: conversion to numerical character references or native characters is required. And for method 1, special precautions need to be taken to avoid double-escaping of & or other named character entities or numerical character references after XSLT processing. Using XHTML as described in X.14 is strongly recommended as it avoids these issues.

HTML method 1 – replace < in HTML markup with &lt;
using Reference names
<Text textformat="02">&lt;P>Maj Sjöwall is best known for the &lt;I>Martin Beck&lt;/I> novels.&lt;/P></Text>
using Short tags (illustrating double-escaping issue)
<d104 textformat="02">&lt;P>Maj Sj&amp;#246;wall is best known for the &lt;I>Martin Beck&lt;/I> novels.&lt;/P></d104>
Only the < character should be changed. HTML tags may be upper or lower case, but lower case is recommended for improved compatibility. In HTML, some end tags such as </P> are optional. Note the use of a ‘double-escaped’ numerical character reference instead of native character ‘ö’ or the character reference &#246; in the Short tags example – this double escaping is strongly discouraged. Use just &#246; without double-escaping, instead of &amp;#246;. (And to avoid doubt, this means that if an & character is intended to appear in the final rendered HTML, it should be included in the ONIX data as &amp;, not as &amp;amp;.) Using this method, there may be issues when the < character is intended to appear in the final rendered HTML, and using the numerical character reference &#60; may help avoid these issues.
HTML method 2 – encapsulate HTML in <![CDATA[ … ]]>
using Reference names
<Text textformat="02"><![CDATA[<P>Maj Sjöwall is best known for the <I>Martin Beck</I> novels.]]></Text>
using Short tags (illustrating use of named character entity)
<d104 textformat="02"><![CDATA[<P>Maj Sj&ouml;wall is best known for the <I>Martin Beck</I> novels.]]></d104>
No special treatment of the < character in markup is necessary. Note the use of a named character entity &ouml; instead of native character ‘ö’. Since text within CDATA is not parsed by the recipient XML system, this may work, even though named character entities are not allowed within parsed ONIX data. However, if extended characters are incorporated into HTML using a named character entity or numerical character reference, special attention should be paid to those characters during testing of the ONIX data exchange. Note also that for the example HTML above, upper case tags are used only to make it clear the markup is HTML and not XHTML – upper case is allowed but not encouraged for HTML, whereas XHTML tags must be lower case.
XML method 1 – replace < in XML markup with &lt;
using Reference names
<Text textformat="03">&lt;para>XML-tagged paragraph with &lt;emph>emphasized&lt;/emph> text&lt;/para></Text>
using Short tags
<d104 textformat="03">&lt;para>XML-tagged paragraph with &lt;emph>emphasized&lt;/emph> words.&lt;/para></d104>
XML method 2 – encapsulate XML in <![CDATA[ … ]]>
using Reference names
<Text textformat="03"><![CDATA[<para>XML-tagged paragraph with <emph>emphasized</emph> words.</para>]]></Text>
using Short tags
<d104 textformat="03"><![CDATA[<para>XML-tagged paragraph with <emph>emphasized</emph> words.</para>]]></d104>

Note that the validity of the HTML or XML markup cannot be checked via the ONIX schemas, since with either method, the markup is effectively ‘hidden’ from the validation process.

The use of CDATA for anything other than inclusion of HTML or XML-tagged text should be avoided.

X.16 Using HTML5

HTML5 can be embedded using either method for HTML 4.

XHTML5 (the XML serialization of HTML5) may be embedded using the method for XHTML 1.0 and 1.1, provided that in addition to the rules that apply to all XHTML, new elements introduced only in XHTML5 are avoided – for example <article> or <section>. Some new elements may be allowed in a future version of the XHTML subset. A full list of allowed and disallowed elements is given in the Guide.

ONIX for Books Message header

Header composite

A group of data elements which together constitute a message header. Mandatory in any ONIX for Books message, and non-repeating. In ONIX 3.0, a number of redundant elements have been deleted, and the Sender and Addressee structures and the name and format of the <SentDateTime> element have been made consistent with other current ONIX formats.

Header
header
1
Sender composite

A group of data elements which together specify the sender of an ONIX for Books message. Mandatory in any ONIX for Books message, and non-repeating.

Sender
sender
1
Sender identifier composite

A group of data elements which together define an identifier of the sender. The composite is optional, and repeatable if more than one identifier of different types is sent; but either a <SenderName> or a <SenderIdentifier> must be included.

SenderIdentifier
senderidentifier
0…n
H.1 Sender identifier type

An ONIX code identifying a scheme from which an identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <SenderIdentifier> composite, and non-repeating.

Fixed length, two digits
List 44
SenderIDType
m379
1
<m379>01</m379>
H.2 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <SenderIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum 50 characters
IDTypeName
b233
0…1
language
  
H.3 Identifier value

An identifier of the type specified in the <SenderIDType> element. Mandatory in each occurrence of the <SenderIdentifier> composite, and non-repeating.

According to the identifier type specified in <SenderIDType>
IDValue
b244
1
  
End of Sender identifier composite
H.4 Sender name

The name of the sender organization, which should always be stated in a standard form agreed with the addressee. Optional and non-repeating; but either a <SenderName> element or a <SenderIdentifier> composite must be included.

Variable length text, suggested maximum 50 characters
SenderName
x298
0…1
<SenderName>HarperCollins London</SenderName>
H.5 Sender contact name

Free text giving the name, department, etc for a contact person in the sender organization who is responsible for the content of the message. Optional and non-repeating.

Variable length text, suggested maximum 300 characters
ContactName
x299
0…1
<x299>Jackie Brown</x299>
H.5a Sender telephone number

A telephone number of the contact person in the sender organization, wherever possible including the plus sign and the international dialling code. Optional, and non-repeating.

Variable length text, suggested maximum length 20 characters
TelephoneNumber
j270
0…1
<j270>+44 20 8843 8607</j270>
H.6 Sender contact e-mail address

A text field giving the e-mail address for a contact person in the sender organization who is responsible for the content of the message. Optional and non-repeating.

Variable length text, suggested maximum 100 characters
EmailAddress
j272
0…1
<j272>jackie.brown@bigpublisher.co.uk</j272>
End of Sender composite
Addressee composite

A group of data elements which together specify the addressee of an ONIX for Books message. Optional, and repeatable if there are several addressees.

Addressee
addressee
0…n
Addressee identifier composite

A group of data elements which together define an identifier of the addressee. The composite is optional, and repeatable if more than one identifier of different types for the same addressee is sent; but either an <AddresseeName> or an <AddresseeIdentifier> must be included.

AddresseeIdentifier
addresseeidentifier
0…n
H.7 Addressee identifier type

An ONIX code identifying a scheme from which an identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <AddresseeIdentifier> composite, and non-repeating.

Fixed length, two digits
List 44
AddresseeIDType
m380
1
<AddresseeIDType>02</AddresseeIDType>
H.8 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <AddresseeIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum 50 characters
IDTypeName
b233
0…1
language
<b233>BigPublisher Customer ID</b233>
H.9 Identifier value

An identifier of the type specified in the <AddresseeIDType> element. Mandatory in each occurrence of the <AddresseeIdentifier> composite, and non-repeating.

According to the identifier type specified in <AddresseeIDType>
IDValue
b244
1
 
End of Addressee identifier composite
H.10 Addressee name

The name of the addressee organization, which should always be stated in a standard form agreed with the addressee. Optional and non-repeating; but either a <AddresseeName> element or a <AddresseeIdentifier> composite must be included.

Variable length text, suggested maximum 50 characters
AddresseeName
x300
0…1
<x300>BiblioAggregator Ltd</x300>
H.11 Addressee contact name

Free text giving the name, department, etc for a contact person in the addressee organization to whom the message is to be directed. Optional and non-repeating.

Variable length text, suggested maximum 300 characters
ContactName
x299
0…1
<ContactName>Mel Carter</ContactName>
H.11a Addressee telephone number

A telephone number of the contact person in the addressee organization, wherever possible including the plus sign and the international dialling code. Optional, and non-repeating.

Variable length text, suggested maximum length 20 characters
TelephoneNumber
j270
0…1
<TelephoneNumber>+44 1632 457890</TelephoneNumber>
H.12 Addressee contact e-mail address

A text field giving the e-mail address for a contact person in the addressee organization. Optional and non-repeating.

Variable length text, suggested maximum 100 characters
EmailAddress
j272
0…1
<j272>carterm@aggregator.co.uk</j272>
End of Addressee composite
H.13 Message sequence number

A monotonic sequence number of the messages in a series sent between trading partners, to enable the receiver to check against gaps and duplicates. Optional and non-repeating.

Positive integer, suggested maximum length 8 digits
MessageNumber
m180
0…1
<m180>1234</m180>
H.14 Message repeat number

A number which distinguishes any repeat transmissions of a message. If this element is used, the original is numbered 1 and repeats are numbered 2, 3 etc. Optional and non-repeating.

Positive integer, suggested maximum length 4 digits
MessageRepeat
m181
0…1
<m181>2</m181>
H.15 Message creation date/time

The date on which the message is sent. Optionally, the time may be added, using the 24-hour clock, with an explicit indication of the time zone if required, in a format based on ISO 8601. Mandatory and non-repeating.

Permitted formats, where ‘T’ and ‘Z’ represent themselves (ie the letters T and Z), and where the symbol ‘±’ represents either ‘+’ or ‘-’ to indicate a timezone offset from UTC.
YYYYMMDDDate only
YYYYMMDDThhmmDate and time (local time of sender)
YYYYMMDDThhmmZUniversal time (UTC) †
YYYYMMDDThhmm±hhmmWith time zone offset from UTC †
YYYYMMDDThhmmssDate and time (with seconds)
YYYYMMDDThhmmssZUniversal time (with seconds)
YYYYMMDDThhmmss±hhmmWith time zone offset from UTC (with seconds)
† indicates the preferred formats
SentDateTime
x307
1
<x307>20100522T1230Z</x307> (12.30pm UTC, 22 May 2010)
The calendar date must use the Gregorian calendar, even if other dates within the message use a different calendar. For all practical purposes, UTC is the same as GMT.
H.16 Message note

Free text giving additional information about the message. Optional, and repeatable in order to provide a note in multiple languages. The language attribute is optional for a single instance of <MessageNote>, but must be included in each instance if <MessageNote> is repeated.

Variable length text, suggested maximum 500 characters
MessageNote
m183
0…n
language
<MessageNote>Updates for titles to be published September 2009</MessageNote>
H.17 Default language of text

An ISO standard code indicating the default language which is assumed for the text of products listed in the message, unless explicitly stated otherwise by sending a ‘language of text’ element in the product record. This default will be assumed for all product records which do not specify a language in Group P.10. Optional and non-repeating.

Fixed length, three lower-case letters. Note that ISO 639 specifies that these codes should always be in lower-case
ISO 639-2/B List 74
DefaultLanguageOfText
m184
0…1
<m184>eng</m184>
H.18 Default price type

An ONIX code indicating the default price type which is assumed for prices listed in the message, unless explicitly stated otherwise in a <Price> composite in the product record. Optional and non-repeating.

Fixed length, two digits
List 58
DefaultPriceType
x310
0…1
<x310>01</x310>
H.19 Default currency

An ISO standard code indicating the currency which is assumed for prices listed in the message, unless explicitly stated otherwise in a <Price> composite in a product record. Optional and non-repeating. All ONIX messages must include an explicit statement of the currency used for any prices. To avoid any possible ambiguity, it is strongly recommended that the currency should be repeated in the <Price> composite for each individual price.

Fixed length, three letters
List 96
DefaultCurrencyCode
m186
0…1
<DefaultCurrencyCode>USD</DefaultCurrencyCode>

End of Header composite

a simple <Header> composite
using Reference names
<Header>
    <Sender>
        <SenderIdentifier>
            <SenderIDType>06</SenderIDType>GLN
            <IDValue>0614141800001</IDValue>
        </SenderIdentifier>
        <SenderName>XYZ Publishers</SenderName>
        <ContactName>Jane Smith</ContactName>
        <TelephoneNumber>+1 212 555 0123</TelephoneNumber>
        <EmailAddress>jane.smith@xyzbooks.com</EmailAddress>
    </Sender>
    <Addressee>
        <AddresseeName>Cooks Books</AddresseeName>
    </Addressee>
    <MessageNumber>781</MessageNumber>
    <SentDateTime>20090408T0750-0500</SentDateTime>12:50pm UTC
    <MessageNote>New cookery titles for May 2009</MessageNote>
    <DefaultLanguageOfText>eng</DefaultLanguageOfText>
</Header>
using Short tags
<header>
    <sender>
        <senderidentifier>
            <m379>06</m379>
            <b244>0614141800001</b244>
        </senderidentifier>
        <x298>XYZ Publishers</x298>
        <x299>Jane Smith</x299>
        <j270>+1 212 555 0123</j270>
        <j272>jane.smith@xyzbooks.com</j272>
    </sender>
    <addressee>
        <x300>Cooks Books</x300>
    </addressee>
    <m180>781</m180>
    <x307>20090408T0750-0500</x307>
    <m183>New cookery titles for May 2009</m183>
    <m184>eng</m184>
</header>

ONIX for Books Product record

Every ONIX message must contain either one or more <Product> composites or a single <NoProduct/> empty element.

Product composite

A product is described by a group of data elements beginning with an XML label <Product> and ending with an XML label </Product>. The entire group of data elements which is enclosed between these two labels constitutes an ONIX product record. The product record is the fundamental unit within an ONIX Product Information message. In almost every case, each product record describes an individually tradable item; and in all circumstances, each tradable item identified by a recognized product identifier should be described by one, and only one, ONIX product record.

In ONIX 3.0, a <Product> record has a mandatory ‘preamble’ comprising data Groups P.1 and P.2, and carrying data that identifies the record and the product to which it refers. This is followed by up to seven ‘blocks’, each optional, some of which are repeatable.

Product
product
0…n

P.1 Record reference, type and source

Two mandatory data elements must be included at the beginning of every product record or update. The first, <RecordReference>, is a string of text which uniquely identifies the record. The second, <NotificationType>, is a code which specifies the type of notification or update.

If the record is sent as a deletion, the reason for deletion can optionally be indicated as plain text in <DeletionText>.

The source of the record can optionally be indicated by one or more of the elements <RecordSourceType>, <RecordSourceIdentifier> and <RecordSourceName>.

P.1.1 Record reference

For every product, you must choose a single record reference which will uniquely identify the Information record which you send out about that product, and which will remain as its permanent identifier every time you send an update. It doesn’t matter what reference you choose, provided that it is unique and permanent. This record reference doesn’t identify the product – even though you may choose to use the ISBN or another product identifier as a part or the whole of your record reference – it identifies your information record about the product, so that the person to whom you are sending an update can match it with what you have previously sent. A good way of generating references which are not part of a recognized product identification scheme but which can be guaranteed to be unique is to prefix a product identifier or a meaningless row ID from your internal database with a reversed Internet domain name which is registered to your organization (reversal prevents the record reference appearing to be a resolvable URL). Alternatively, use a UUID.

This field is mandatory and non-repeating.

Variable length alphanumeric, suggested maximum length 100 characters
RecordReference
a001
1
<a001>com.xyzpublishers.onix.36036</a001> (36036 is row ID in an internal database that is the source of the data in the record)
P.1.2 Notification or update type code

An ONIX code which indicates the type of notification or update which you are sending. Mandatory and non-repeating.

Fixed length, two digits
List 1
NotificationType
a002
1
<NotificationType>02</NotificationType> (Advance notification)
P.1.3 Reason for deletion

Free text which indicates the reason why an ONIX record is being deleted. Optional and repeatable, and may occur only when the <NotificationType> element carries the code value 05. The language attribute is optional for a single instance of <DeletionText>, but must be included in each instance if <DeletionText> is repeated. Note that it refers to the reason why the record is being deleted, not the reason why a product has been ‘deleted’ (in industries which use this terminology when a product is withdrawn).

Variable length text, suggested maximum length 100 characters
DeletionText
a199
0…n
language
<a199>Issued in error</a199>
P.1.4 Record source type code

An ONIX code which indicates the type of source which has issued the ONIX record. Optional and non-repeating, independently of the occurrence of any other field.

Fixed length, two digits
List 3
RecordSourceType
a194
0…1
<a194>01</a194> (Publisher)
Record source identifier composite

A group of data elements which together define an identifier of the organization which is the source of the ONIX record. Optional, and repeatable in order to send multiple identifiers for the same organization.

RecordSourceIdentifier
recordsourceidentifier
0…n
P.1.5 Record source identifier type code

An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <RecordSourceIdentifier> composite, and non-repeating.

Fixed length, two digits
List 44
RecordSourceIDType
x311
1
<x311>03</x311> (Deutsche Bibliothek publisher identifier)
P.1.6 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Used when, and only when, the code in the <RecordSourceIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<b233>KNV</b233>
P.1.7 Identifier value

An identifier of the type specified in the <RecordSourceIDType> element. Mandatory in each occurrence of the <RecordSourceIdentifier> composite, and non-repeating.

According to the identifier type specified in <RecordSourceIDType>
IDValue
b244
1
<b244>8474339790</b244>
End of Record source identifier composite
P.1.8 Record source name

The name of the party which issued the record, as free text. Optional and non-repeating, independently of the occurrence of any other field.

Variable length text, suggested maximum length 100 characters
RecordSourceName
a197
0…1
<RecordSourceName>Cambridge University Press</RecordSourceName>
The record source need not be the same as the <Sender> specified in the message header: an aggregator may be the sender of a message containing records sourced from several different record suppliers.

P.2 Product identifiers

A valid product identifier must be included in every <Product> record. The GTIN-13 (formerly EAN-13) article number is the preferred identifier for international use across a range of product types. Other product numbers may be included where they exist. The XML Schema or DTD requires at least one number to be sent, but does not enforce or rule out any particular types or combinations.

In ONIX 3.0, redundant elements have been deleted, so the <ProductIdentifier> composite must be used.

Product identifier composite

A group of data elements which together specify an identifier of a product in accordance with a particular scheme. Mandatory within <Product>, and repeatable with different identifiers for the same product. As well as standard identifiers, the composite allows proprietary identifiers (for example SKUs assigned by wholesalers or vendors) to be sent as part of the ONIX record.

ISBN-13 numbers in their unhyphenated form constitute a range of EAN.UCC GTIN-13 numbers that has been reserved for the international book trade. Effective from 1 January 2007, it was agreed by ONIX national groups that it should be mandatory in an ONIX <Product> record for any item carrying an ISBN-13 to include the ISBN-13 labelled as an EAN.UCC GTIN-13 number (ProductIDType code 03), since this is how the ISBN-13 will be used in book trade transactions. For many ONIX applications this will also be sufficient.

For some ONIX applications, however, particularly when data is to be supplied to the library sector, there may be reasons why the ISBN-13 must also be sent labelled distinctively as an ISBN-13 (ProductIDType code 15). Users should consult ‘good practice’ guidelines and/or discuss with their trading partners.

Note that for some identifiers such as ISBN, punctuation (typically hyphens or spaces for ISBNs) is used to enhance readability when printed, but the punctuation is dropped when carried in ONIX data. But for other identifiers – for example DOI – the punctuation is an integral part of the identifier and must always be included.

ProductIdentifier
productidentifier
1…n
P.2.1 Product identifier type code

An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <ProductIdentifier> composite, and non-repeating.

Fixed-length text, two digits
List 5
ProductIDType
b221
1
<ProductIDType>03</ProductIDType> (GTIN-13)
P.2.2 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <ProductIDType> element indicates a proprietary scheme, eg a wholesaler’s own code. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<IDTypeName>KNV</IDTypeName>
P.2.3 Identifier value

An identifier of the type specified in the <ProductIDType> element. Mandatory in each occurrence of the <ProductIdentifier> composite, and non-repeating.

According to the identifier type specified in <ProductIDType>
IDValue
b244
1
<b244>9780300117264</b244>
End of Product identifier composite
GTIN-13, ISBN-13 and DOI (ISBN-A) for same product
using Reference names
<ProductIdentifier>
    <ProductIDType>03</ProductIDType>
    <IDValue>9780001234567</IDValue>
</ProductIdentifier>
<ProductIdentifier>
    <ProductIDType>15</ProductIDType>
    <IDValue>9780001234567</IDValue>
</ProductIdentifier>
<ProductIdentifier>
    <ProductIDType>06</ProductIDType>
    <IDValue>10.978.000/1234567</IDValue>
</ProductIdentifier>
<ProductIdentifier>
    <ProductIDType>26</ProductIDType>
    <IDValue>10.978.000/1234567</IDValue>
</ProductIdentifier>
using Short tags
<productidentifier>
    <b221>03</b221>GTIN-13
    <b244>9780001234567</b244>
</productidentifier>
<productidentifier>
    <b221>15</b221>ISBN
    <b244>9780001234567</b244>
</productidentifier>
<productidentifier>
    <b221>06</b221>DOI
    <b244>10.978.000/1234567</b244>
</productidentifier>
<productidentifier>
    <b221>26</b221>ISBN-A
    <b244>10.978.000/1234567</b244>
</productidentifier>
Barcode composite

A group of data elements which together specify a barcode type and its position on a product. Optional: expected to be used only in North America. Repeatable if more than one type of barcode is carried on a single product. The absence of this composite does not mean that a product is not bar-coded.

Barcode
barcode
0…n
P.2.4 Barcode type

An ONIX code indicating whether, and in what form, a barcode is carried on a product. Mandatory in any instance of the <Barcode> composite, and non-repeating.

Fixed length, two digits
List 141
BarcodeType
x312
1
<x312>03</x312> (GTIN-13+5 – US dollar price encoded)
P.2.5 Position on product

An ONIX code indicating a position on a product; in this case, the position in which a barcode appears. Required if the <BarcodeType> element indicates that the barcode appears on the product, even if the position is ‘unknown’. Omitted if the <BarcodeType> element specifies that the product does not carry a barcode. Non-repeating.

Fixed length, two digits
List 142
PositionOnProduct
x313
0…1
<x313>01</x313> (Cover 4 – the back cover of a book)
End of Barcode composite
barcode in conventional position on back cover
using Reference names
<Barcode>
    <BarcodeType>02</BarcodeType>
    <PositionOnProduct>01</PositionOnProduct>
</Barcode>
using Short tags
<barcode>
    <x312>02</x312>GTIN-13 (no extension)
    <x313>01</x313>Cover 4 (outside back cover)
</barcode>
positive indication of no barcode
using Reference names
<Barcode>
    <BarcodeType>00</BarcodeType>
</Barcode>
using Short tags
<barcode>
    <x312>00</x312>No barcode on product
</barcode>

Block 1: Product description

Descriptive detail composite

The descriptive detail block covers data Groups P.3 to P.13, all of which are essentially part of the factual description of the form and content of a product. The block as a whole is non-repeating. It is mandatory in any <Product> record unless the <NotificationType> in Group P.1 indicates that the record is an update notice which carries only those blocks in which changes have occurred.

DescriptiveDetail
descriptivedetail
0…1

P.3 Product form

Group P.3 carries elements that describe the form of a product, its key content type (text, audio, etc) and, in the case of digital products, any usage constraints that are enforced through DRM protection or otherwise.

Additional guidance on the description of digital products in ONIX 3.0 will be found in a separate document ONIX for Books Product Information Message: How to Describe Digital Products in ONIX 3.

P.3.1 Product composition

An ONIX code which indicates whether a product consists of a single item or multiple items. Mandatory in an occurrence of <DescriptiveDetail>, and non-repeating.

Fixed length, two digits
List 2
ProductComposition
x314
1
<x314>00</x314> (Single-item product)
P.3.2 Product form code

An ONIX code which indicates the primary form of a product. Mandatory in an occurrence of <DescriptiveDetail>, and non-repeating. In ONIX 3.0, the handling of multiple-item products has been changed so that the form of the contained items is now specified only in the <ProductPart> composite (equivalent to <Contained Item> in ONIX 2.1, and now forming Group P.4), which must be included for full description of any multiple-item product.

Fixed length, two letters (or the digits 00)
List 150
ProductForm
b012
1
<ProductForm>BB</ProductForm> (Hardback book)
P.3.3 Product form detail

An ONIX code which provides added detail of the medium and/or format of the product. Optional, and repeatable in order to provide multiple additional details.

Fixed length, four characters: one letter followed by three digits
List 175
ProductFormDetail
b333
0…n
<b333>B206</b333> (Pop-up book)
Product form feature composite

An optional group of data elements which together describe an aspect of product form that is too specific to be covered in the <ProductForm> and <ProductFormDetail> elements. Repeatable in order to describe different aspects of the product form.

ProductFormFeature
productformfeature
0…n
P.3.4 Product form feature type

An ONIX code which specifies the feature described by an instance of the <ProductFormFeature> composite, eg binding color. Mandatory in each occurrence of the composite, and non-repeating.

Fixed length, two digits
List 79
ProductFormFeatureType
b334
1
<b334>02</b334> (Page edge color)
P.3.5 Product form feature value

A controlled value that describes a product form feature. Presence or absence of this element depends on the <ProductFormFeatureType>, since some product form features (eg thumb index) do not require an accompanying value, while others (eg text font) require free text in <ProductFormFeatureDescription>; and others may have both code and free text. Non-repeating.

Dependent on the scheme specified in <ProductFormFeatureType>
Dependent on the scheme specified in <ProductFormFeatureType>
For cover binding color, see List 98
For page edge color, see List 98
For special cover material, see List 99
For text font, use free text in <ProductFormFeatureDescription>, which may include font name and/or size
For DVD region codes, see List 76
For CPSIA choking hazard warning, see List 143
For EU Toy Safety hazard warnings, see List 184
For various paper certification schemes (FSC, PEFC etc), see List 79. <ProductFormFeatureType> identifies the certification scheme, and <ProductFormFeatureValue> may carry a Chain of Custody (COC) number. For certified recycled paper, a separate repeat of the <ProductFormFeature> composite may carry the percent post-consumer waste used in a product
For specific versions of common e-publication file formats, (eg the IDPF’s EPUB 2.0.1), use <ProductFormFeatureType> code 15 and a value from List 220. For e-publication formats not covered in List 220, use <ProductFormFeatureType> code 10 and a period-separated list of numbers (eg ‘7’, ‘1.5’ or ‘3.10.7’) in <ProductFormFeatureValue>
For required operating system for a digital product, see List 176. You should in addition include operating system version information (major and minor version numbers as necessary, eg ‘10.6.4 or later’ for Mac OS 10.6.4, ‘7 SP1 or later’ for Windows 7 Service Pack 1) in <ProductFormFeatureDescription>. For other system requirements for a digital product (eg specific memory, storage or other hardware requirements), use free text in <ProductFormFeatureDescription> within a separate repeat of the <ProductFormFeature> composite
For e-publication accessibility features for print-impaired readers, see List 196
Further features with corresponding code lists may be added from time to time without a re-issue of this document – see the latest release of List 79
ProductFormFeatureValue
b335
0…1
<b335>BLK</b335> (Black color)
P.3.6 Product form feature description

If the <ProductFormFeatureType> requires free text rather than a code value, or if the code in <ProductFormFeatureValue> does not adequately describe the feature, a short text description may be added. Optional, and repeatable to provide parallel descriptive text in multiple languages. The language attribute is optional for a single instance of <ProductFormFeatureDescription>, but must be included in each instance if <ProductFormFeatureDescription> is repeated.

Variable length text, suggested maximum length 500 characters
ProductFormFeatureDescription
b336
0…n
language
<b336>11pt Helvetica</b336>
End of Product form feature composite
use of <ProductFormFeature> to describe large print for visually impaired readers
using Reference names
<ProductFormFeature>
    <ProductFormFeatureType>03</ProductFormFeatureType>
    <ProductFormFeatureDescription>18pt Tiresias LP</ProductFormFeatureDescription>
</ProductFormFeature>
using Short tags
<productformfeature>
    <b334>03</b334>Text font
    <b336>18pt Tiresias LP</b336>
</productformfeature>
denoting use of FSC-certified paper
using Reference names
<ProductFormFeature>
    <ProductFormFeatureType>32</ProductFormFeatureType>
    <ProductFormFeatureValue>SW-COC-1806</ProductFormFeatureValue>
</ProductFormFeature>
using Short tags
<productformfeature>
    <b334>32</b334>FSC mixed sources
    <b335>SW-COC-1806</b335>Chain of custody number
</productformfeature>
book packaged as mobile phone ‘app’, including audio and video content
using Reference names
<ProductForm>ED</ProductForm>
<ProductFormDetail>E134</ProductFormDetail>
<ProductFormFeature>
    <ProductFormFeatureType>06</ProductFormFeatureType>
    <ProductFormFeatureValue>03</ProductFormFeatureValue>
    <ProductFormFeatureDescription>4.1 or later</ProductFormFeatureDescription>
</ProductFormFeature>
<PrimaryContentType>10</PrimaryContentType>
<ProductContentType>06</ProductContentType>
<ProductContentType>13</ProductContentType>
using Short tags
<b012>ED</b012>Digital download
<b333>E134</b333>Phone ‘app’ for iOS
<productformfeature>
    <b334>06</b334>Operating system
    <b335>03</b335>iOS
    <b336>4.1 or later</b336>Version 4.1
</productformfeature>
<x416>10</x416>Eye-readable text
<b385>06</b385>Enhanced with video
<b385>13</b385>and audio content
P.3.7 Product packaging type code

An ONIX code which indicates the type of outer packaging used for the product. Optional and non-repeating.

Fixed length, two digits
List 80
ProductPackaging
b225
0…1
<ProductPackaging>05</ProductPackaging> (Jewel case)
P.3.8 Product form description

If product form codes do not adequately describe the product, a short text description may be added to give a more detailed specification of the product form. The field is optional, and repeatable to provide parallel descriptions in multiple languages. The language attribute is optional for a single instance of <ProductFormDescription>, but must be included in each instance if <ProductFormDescription> is repeated to provide parallel descriptions in multiple languages.

Variable length text, suggested maximum length 200 characters
ProductFormDescription
b014
0…n
language
<ProductFormDescription language="eng">Hardback book die-cut into car shape, with wheels attached to front and back covers</ProductFormDescription>
P.3.9 Trade category code

An ONIX code which indicates a trade category which is somewhat related to, but not properly an attribute of, product form. Optional and non-repeating.

Fixed length, two digits
List 12
TradeCategory
b384
0…1
<TradeCategory>03</TradeCategory> (Sonderausgabe – Germany)
P.3.10 Primary content type code

An ONIX code which indicates the primary or only content type included in a product. The element is intended to be used in particular for digital products, when the sender wishes to make it clear that one of a number of content types (eg text, audio, video) is the primary type for the product. Other content types may be specified in the <ProductContentType>. Optional and non-repeating.

Fixed length, two digits
List 81
PrimaryContentType
x416
0…1
<x416>10</x416> (Eye-readable text)
P.3.11 Product content type code

An ONIX code which indicates a content type included in a product. The element is intended to be used in particular for digital products, to specify content types other than the primary type, or to list content types when none is singled out as the primary type. Optional, and repeatable to list multiple content types.

Fixed length, two digits
List 81
ProductContentType
b385
0…n
<ProductContentType>11</ProductContentType> (Musical notation)
Measure composite

An optional group of data elements which together identify a measurement and the units in which it is expressed; used to specify the overall dimensions of a physical product including its packaging (if any). Repeatable to provide multiple combinations of dimension and unit.

Measure
measure
0…n
P.3.12 Measure type code

An ONIX code indicating the dimension which is specified by an occurrence of the measure composite. Mandatory in each occurrence of the <Measure> composite, and non-repeating.

Fixed length, two digits
List 48
MeasureType
x315
1
<x315>01</x315> (Height)
P.3.13 Measurement

The number which represents the dimension specified in <MeasureType> in the measure units specified in <MeasureUnitCode>. Mandatory in each occurrence of the <Measure> composite, and non-repeating.

Positive real number, with explicit decimal point when required, suggested maximum length 6 characters
Measurement
c094
1
<c094>8.25</c094>
P.3.14 Measure unit code

An ONIX code indicating the measure unit in which dimensions are given. Mandatory in each occurrence of the <Measure> composite, and non-repeating. This element must follow the dimension to which the measure unit applies. See example below.

Fixed length, two letters
List 50
MeasureUnitCode
c095
1
<c095>mm</c095>
End of Measure composite
use of the <Measure> composite
using Reference names
<Measure>
    <MeasureType>01</MeasureType>Height
    <Measurement>9.25</Measurement>9.25
    <MeasureUnitCode>in</MeasureUnitCode>inches
</Measure>
<Measure>
    <MeasureType>02</MeasureType>Width
    <Measurement>6.25</Measurement>6.25
    <MeasureUnitCode>in</MeasureUnitCode>inches
</Measure>
<Measure>
    <MeasureType>03</MeasureType>Spine thickness
    <Measurement>1.2</Measurement>1.2
    <MeasureUnitCode>in</MeasureUnitCode>inches
</Measure>
<Measure>
    <MeasureType>08</MeasureType>Weight
    <Measurement>244</Measurement>224
    <MeasureUnitCode>gr</MeasureUnitCode>grams
</Measure>
using Short tags
<measure>
    <x315>01</x315>
    <c094>9.25</c094>
    <c095>in</c095>
</measure>
<measure>
    <x315>02</x315>
    <c094>6.25</c094>
    <c095>in</c095>
</measure>
<measure>
    <x315>03</x315>
    <c094>1.2</c094>
    <c095>in</c095>
</measure>
<measure>
    <x315>08</x315>
    <c094>244</c094>
    <c095>gr</c095>
</measure>
P.3.15 Country of manufacture

An ISO code identifying the country of manufacture of a single-item product, or of a multiple-item product when all items are manufactured in the same country. This information is needed in some countries to meet regulatory requirements. Optional and non-repeating.

Fixed length, two letters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes, see List 91
CountryOfManufacture
x316
0…1
<x316>US</x316>
P.3.16 Digital product technical protection

An ONIX code specifying whether a digital product has DRM or other technical protection features. Optional, and repeatable if a product has two or more kinds of protection (ie different parts of a product are protected in different ways).

Fixed length, two digits
List 144
EpubTechnicalProtection
x317
0…n
<x317>03</x317> (Has digital watermarking)
‘Epub’ (‘e-publication’) here and in other element names below refers to any digital product, and has no necessary link with the .epub file format developed by the IDPF
Usage constraint composite (digital products)

An optional group of data elements which together describe a usage constraint on a digital product (or the absence of such a constraint), whether enforced by DRM technical protection, inherent in the platform used, or specified by license agreement. Repeatable in order to describe multiple constraints on usage.

EpubUsageConstraint
epubusageconstraint
0…n
P.3.17 Usage type (digital products)

An ONIX code specifying a usage of a digital product. Mandatory in each occurrence of the <EpubUsageConstraint> composite, and non-repeating.

Fixed length, two digits
List 145
EpubUsageType
x318
1
<x318>05</x318> (Text-to-speech)
P.3.18 Usage status (digital products)

An ONIX code specifying the status of a usage of a digital product, eg permitted without limit, permitted with limit, prohibited. Mandatory in each occurrence of the <EpubUsageConstraint> composite, and non-repeating.

Fixed length, two digits
List 146
EpubUsageStatus
x319
1
<x319>03</x318> (Prohibited)
Usage limit composite (digital products)

An optional group of data elements which together specify a quantitative limit on a particular type of usage of a digital product. Repeatable in order to specify two or more limits on the usage type.

EpubUsageLimit
epubusagelimit
0…n
P.3.19 Usage quantity (digital products)

A numeric value representing the maximum permitted quantity of a particular type of usage. Mandatory in each occurrence of the <EpubUsageLimit> composite, and non-repeating.

Positive real number, with explicit decimal point when required, or zero, as appropriate for the units specified in <EpubUsageUnit>
Quantity
x320
1
<Quantity>10</Quantity>
P.3.20 Usage unit (digital products)

An ONIX code for a unit in which a permitted usage quantity is stated. Mandatory in each occurrence of the <EpubUsageLimit> composite, and non-repeating.

Fixed length, two digits
List 147
EpubUsageUnit
x321
1
<EpubUsageUnit>07</EpubUsageUnit> (Maximum number of concurrent users)
End of Usage limit composite (digital products)
End of Usage constraint composite (digital products)
Digital product license composite

An optional and non-repeatable composite carrying the name or title of the license governing use of the product, and a link to the license terms in eye-readable or machine-readable form.

EpubLicense
epublicense
0…1
P.3.20a Digital product license name

The name or title of the license. Mandatory in any <EpubLicense> composite, and repeatable to provide the license name in multiple languages. The language attribute is optional for a single instance of <EpubLicenseName>, but must be included in each instance if <EpubLicenseName> is repeated.

Variable length text, suggested maximum length 100 characters
EpubLicenseName
x511
1…n
language
<x511>Elsevier e-book EULA v5</x511>
Digital product license expression composite

An optional composite that carries details of a link to an expression of the license terms, which may be in human-readable or machine-readable form. Repeatable when there is more than one expression of the license.

EpubLicenseExpression
epublicenseexpression
0…n
P.3.20b License expression type

An ONIX code identifying the nature or format of the license expression specified in the <EpubLicenseExpressionLink> element. Mandatory within the <EpubLicenseExpression> composite, and non-repeating.

Fixed-length text, two digits
List 218
EpubLicenseExpressionType
x508
1
<x508>10</x508> (ONIX-PL license expression)
P.3.20c License expression type name

A short free-text name for a license expression type, when the code in <EpubLicenseExpressionType> provides insufficient detail – for example when a machine-readable license is expressed using a particular proprietary encoding scheme. Optional and non-repeating, and must be included when (and only when) the <EpubLicenseExpressionType> element indicates the expression is encoded in a proprietary way.

Variable length text, suggested maximum length 50 characters
EpubLicenseExpressionTypeName
x509
0…1
language
<x509>ABC-XML</x509>
End of Digital product license expression composite
End of Digital product license composite
e-book with certain usage limits enforced by DRM, and link to license
using Reference names
<EpubTechnicalProtection>03</EpubTechnicalProtection>
<EpubUsageConstraint>
    <EpubUsageType>05</EpubUsageType>
    <EpubUsageStatus>01</EpubUsageStatus>
</EpubUsageConstraint>
<EpubUsageConstraint>
    <EpubUsageType>03</EpubUsageType>
    <EpubUsageStatus>02</EpubUsageStatus>
    <EpubUsageLimit>
        <Quantity>10</Quantity>
        <EpubUsageUnit>05</EpubUsageUnit>
    </EpubUsageLimit>
</EpubUsageConstraint>
<EpubUsageConstraint>
    <EpubUsageType>06</EpubUsageType>
    <EpubUsageStatus>02</EpubUsageStatus>
    <EpubUsageLimit>
        <Quantity>1</Quantity>
        <EpubUsageUnit>10</EpubUsageUnit>
    </EpubUsageLimit>
    <EpubUsageLimit>
        <Quantity>14</Quantity>
        <EpubUsageUnit>09</EpubUsageUnit>
    </EpubUsageLimit>
</EpubUsageConstraint>
<EpubLicense>
    <EpubLicenseName>MyPublisher EULA v3</EpubLicenseName>
    <EpubLicenseExpression>
        <EpubLicenseExpressionType>01</EpubLicenseExpressionType>
        <EpubLicenseExpressionLink>http://www.mypublisher.com/​licenses/​EULA_v3.pdf​</EpubLicenseExpressionLink>
    </EpubLicenseExpression>
</EpubLicense>
using Short tags
<x317>03</x317>ACS4 DRM
<epubusageconstraint>
    <x318>05</x318>Text to speech
    <x319>01</x319>is unrestricted
</epubusageconstraint>
<epubusageconstraint>
    <x318>03</x318>Copy/paste
    <x319>02</x319>is limited
    <epubusagelimit>
        <x320>10</x320>Ten
        <x321>05</x321>percent
    </epubusagelimit>
</epubusageconstraint>
<epubusageconstraint>
    <x318>06</x318>Lending
    <x319>02</x319>is limited
    <epubusagelimit>
        <x320>1</x320>Only one
        <x321>10</x321>occasion
    </epubusagelimit>
    <epubusagelimit>
        <x320>14</x320>For fourteen
        <x321>09</x321>days
    </epubusagelimit>
</epubusageconstraint>
<epublicense>
    <x511>MyPublisher EULA v3</x511>
    <epublicenseexpression>
        <x508>01</x508>Human-readable
        <x510>http://www.mypublisher.com/​licenses/​EULA_v3.pdf​</x510>text of license
    </epublicenseexpression>
</epublicense>
P.3.21 Map scale

The scale of a map, expressed as a ratio 1:nnnnn; only the number nnnnn is carried in the data element, without spaces or punctuation. Optional, and repeatable if a product comprises maps with two or more different scales.

Positive integer, suggested maximum length 8 digits
MapScale
b063
0…n
<b063>50000</b063> (One to 50,000, 2cm = 1km)
Product classification composite

An optional group of data elements which together define a product classification (not to be confused with a subject classification). The intended use is to enable national or international trade classifications (also known as commodity codes) to be carried in an ONIX record. The composite is repeatable if parts of the product are classified differently within a single product classification scheme, or to provide classification codes from multiple classification schemes.

ProductClassification
productclassification
0…n
P.3.22 Product classification type code

An ONIX code identifying the scheme from which the identifier in <ProductClassificationCode> is taken. Mandatory in each occurrence of the <ProductClassification> composite, and non-repeating.

Fixed length, two digits
List 9
ProductClassificationType
b274
1
<b274>02</b274> (UNSPSC)
P.3.22a Product classification type name

A name which identifies a proprietary classification scheme (ie a scheme which is not a standard and for which there is no individual scheme type code). Should be included when, and only when, the code in the <ProductClassificationType> element indicates a proprietary scheme, ie the sender’s own category scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
ProductClassificationTypeName
x555
0…1
language
<x555>PublishipGoodsCode</x555>
P.3.23 Product classification code

A classification code from the scheme specified in <ProductClassificationType>. Mandatory in each occurrence of the <ProductClassification> composite, and non-repeating.

According to the identifier type specified in <ProductClassificationType>
ProductClassificationCode
b275
1
<b275>55101514</b275> (Sheet music in UNSPSC classification scheme)
P.3.24 Percentage

The percentage of the unit value of the product that is assignable to a designated product classification. Optional and non-repeating. Used when a mixed product (eg book and CD) belongs partly to two or more product classes within a particular scheme. If omitted, the product classification code applies to 100% of the product.

Real number between zero and 100 (inclusive), with explicit decimal point when required, suggested maximum length 7 characters
Percent
b337
0…1
<Percent>66.67</Percent>
End of Product classification composite
supplying a commodity code
using Reference names
<ProductClassification>
    <ProductClassificationType>02</ProductClassificationType>
    <ProductClassificationCode>55101509</ProductClassificationCode>
</ProductClassification>
using Short tags
<productclassification>
    <b274>02</b274>UN Standard Products and Services Code
    <b275>55101509</b275>Educational or vocational textbooks
</productclassification>

P.4 Product parts

Elements in Group P.4 are used only when the <ProductComposition> and <ProductForm> codes for the product indicate that it is either a multiple-component or multiple-item retail product, or a trade pack. In either of these circumstances, ONIX 3.0 usage requires that there must be at least one instance of the <ProductPart> composite, to describe the items or components that together make up the product.

Additional guidance on the description of product parts in ONIX 3.0 will be found in a separate document ONIX for Books Product Information Format: How to describe sets, series and multiple-item products.

Product part composite

A group of data elements which together describe an item which is part of or contained within a multiple-component or multiple-item product or a trade pack. The composite must be used with all multi-component or multi-item products and packs to specify (for example) the item(s) and item quantities included in a combined book plus audiobook product, a multi-volume set, a filled dumpbin, or a classroom pack. In other cases, where parts are not individually identified, it is used to state the product form(s) and the quantity or quantities of each form contained within the product. The composite must be repeated for each item or component.

Each instance of the <ProductPart> composite must carry a <ProductForm> code and a quantity, even if the quantity is ‘1’. If the composite refers to a number of copies of a single item, the quantity must be sent as <NumberOfCopies>, normally accompanied by a <ProductIdentifier>. If the composite refers to a number of different items of the same form, without identifying them individually, the quantity must be sent as <NumberOfItemsOfThisForm>.

ProductPart
productpart
0…n
P.4.1 ‘Primary part’ indicator

An empty element that allows a sender to identify a product part as the ‘primary’ part of a multiple-item product. For example, in a ‘book and toy’ or ‘book and DVD’ product, the book may be regarded as the primary part. Optional and non-repeating.

XML empty element
PrimaryPart/
x457/
0…1
<PrimaryPart/>
Product identifier composite (product part)

A group of data elements which together define an identifier of a product in accordance with a specified scheme, used here to carry the product identifier of a product part. Optional, but required when an occurrence of <ProductPart> specifies an individual item with its own identifier, and repeatable with different identifiers for the same product part.

ProductIdentifier
productidentifier
0…n
P.4.2 Product identifier type code

An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <ProductIdentifier> composite, and non-repeating.

Fixed-length text, two digits
List 5
ProductIDType
b221
1
<ProductIDType>03</ProductIDType> (GTIN-13)
P.4.3 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <ProductIDType> element indicates a proprietary scheme, eg a wholesaler’s own code. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<IDTypeName>KNV</IDTypeName>
P.4.4 Identifier value

An identifier of the type specified in the <ProductIDType> element. Mandatory in each occurrence of the <ProductIdentifier> composite, and non-repeating.

According to the identifier type specified in <ProductIDType>
IDValue
b244
1
<b244>9780300117264</b244>
End of Product identifier composite (product part)
P.4.5 Product form code (product part)

An ONIX code which indicates the primary form of a product part. Mandatory in each occurrence of <ProductPart>, and non-repeating.

Fixed length, two letters (or the digits 00)
List 150
ProductForm
b012
1
<b012>BB</b012> (Hardback book)
P.4.6 Product form detail (product part)

An ONIX code which provides added detail of the medium and/or format of a product part. Optional, and repeatable in order to provide multiple additional details.

Fixed length, four characters: one letter followed by three digits
List 175
ProductFormDetail
b333
0…n
<b333>B206</b333> (Pop-up book)
Product form feature composite (product part)

An optional group of data elements which together describe an aspect of product form that is too specific to be covered in the <ProductForm> and <ProductFormDetail> elements. Repeatable in order to describe different aspects of the form of the product part. The composite is included here so that it can for example be used to carry consumer protection data related to a product part.

ProductFormFeature
productformfeature
0…n
P.4.7 to P.4.9: elements in the Product form feature composite

Elements P.4.7 to P.4.9 in the <ProductFormFeature> composite are identical to P.3.4 to P.3.6 as specified in Group P.3.

End of Product form feature composite (product part)
P.4.9a Product packaging type code (product part)

An ONIX code which indicates the type of packaging used for the product part. Optional, and not repeatable.

Fixed length, two digits
List 80
ProductPackaging
b225
0…1
<b225>05</b225> (Jewel case)
P.4.10 Product form description (product part)

If product form codes do not adequately describe the contained item, a short text description may be added. Optional and repeatable. The language attribute is optional for a single instance of <ProductFormDescription>, but must be included in each instance if <ProductFormDescription> is repeated.

Variable length text, suggested maximum length 200 characters
ProductFormDescription
b014
0…n
language
<b014>Birdsong recordings illustrating the accompanying text</b014>
P.4.11 Product content type code (product part)

An ONIX code which indicates certain types of content which are closely related to but not strictly an attribute of product form, eg audiobook. Optional and repeatable.

Fixed-length text, two digits
List 81
ProductContentType
b385
0…n
<ProductContentType>01</ProductContentType> (Audiobook)
Measure composite (product part)

An optional group of data elements which together identify a measurement and the units in which it is expressed; used to specify the overall dimensions of a physical product part including its inner packaging (if any). Repeatable to provide multiple combinations of dimension and unit.

Measure
measure
0…n
P.4.11a to P.4.11c: elements in the Measure composite

Elements P.4.11a to P.4.11c in the <Measure> composite are identical to P.3.12 to P.3.14 as specified in Group P.3.

End of Measure composite (product part)
P.4.12 Number of items of a specified form (product part)

When product parts are listed as a specified number of different items in a specified form, without identifying the individual items, <NumberOfItemsOfThisForm> must be used to carry the quantity, even if the number is ‘1’. Consequently the element is mandatory and non-repeating in an occurrence of the <ProductPart> composite if <NumberOfCopies> is not present; and it must not be used if <ProductIdentifier> is present.

Positive integer, suggested maximum length 4 digits
NumberOfItemsOfThisForm
x322
0…1
<x322>3</x322>
P.4.13 Number of copies (product part)

When product parts are listed as a specified number of copies of a single item, usually identified by a <ProductIdentifier>, <NumberOfCopies> must be used to specify the quantity, even if the number is ‘1’. It must be used when a multiple-item product or pack contains (a) a quantity of a single item; or (b) one of each of several different items (as in a multi-volume set); or (c) one or more of each of several different items (as in a dumpbin carrying copies of two different books, or a classroom pack containing a teacher’s text and twenty student texts). Consequently the element is mandatory, and non-repeating, in an occurrence of the <ProductPart> composite if <NumberOfItemsOfThisForm> is not present. It is normally accompanied by a <ProductIdentifier>; but in exceptional circumstances, if the sender’s system is unable to provide an identifier at this level, it may be sent with product form coding and without an ID.

Positive integer, suggested maximum length 4 digits
NumberOfCopies
x323
0…1
<x323>24</x323> (24 copies of a single item in eg a classroom pack of textbooks)
P.4.14 Country of manufacture (product part)

A code identifying the country in which a product part was manufactured, if different product parts were manufactured in different countries. This information is needed in some countries to meet regulatory requirements. Optional and non-repeating.

Fixed length, two letters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes, see List 91
CountryOfManufacture
x316
0…1
<CountryOfManufacture>US</CountryOfManufacture>
End of Product part composite
three-volume work, slip-cased
using Reference names
<ProductComposition>10</ProductComposition>
<ProductForm>SC</ProductForm>
<!-- Measure composites omitted for brevity -->
<ProductPart>
    <ProductForm>BB</ProductForm>
    <NumberOfItemsOfThisForm>3</NumberOfItemsOfThisForm>
</ProductPart>
using Short tags
<x313>10</x313>Multi-item retail product
<b012>SC</b012>Slip-cased set
<!-- measure composites omitted -->
<productpart>
    <b012>BB</b012>Hardback
    <x322>3</x322>3 vols
</productpart>
book with two-disc audiobook in sleeve attached to inside back cover
using Reference names
<ProductComposition>10</ProductComposition>
<ProductForm>SF</ProductForm>
<!-- Measure composites omitted for brevity -->
<ProductPart>
    <PrimaryPart/>
    <ProductIdentifier>
        <ProductIDType>03</ProductIDType>
        <IDValue>9780001234567</IDValue>
    </ProductIdentifier>
    <ProductForm>BC</ProductForm>
    <NumberOfCopies>1</NumberOfCopies>
</ProductPart>
<ProductPart>
    <ProductForm>AC</ProductForm>
    <ProductFormDetail>A101</ProductFormDetail>
    <NumberOfItemsOfThisForm>2</NumberOfItemsOfThisForm>
</ProductPart>
using Short tags
<x313>10</x313>Multi-item retail product
<b012>SF</b012>Multi-item retail product, part(s) enclosed
<!-- measure composites omitted -->
<productpart>
    <x457/>Book is the primary part of the product
    <productidentifier>
        <b221>03</b221>GTIN-13
        <b244>9780001234567</b244>(of book as separate product)
    </productidentifier>
    <b012>BC</b012>Paperback
    <x323>1</x323>
</productpart>
<productpart>
    <b012>AC</b012>CD-Audio
    <b333>A101</b333>‘Red Book’ audio format
    <x322>2</x322>Two discs
</productpart>

P.5 Collection

Group P.5 is used to describe attributes of a bibliographic collection to which a product belongs.

A bibliographic collection in ONIX 3.0 means a fixed or indefinite number of products, published over a fixed or indefinite time period, which share collective attributes (including a collective title) that are required as part of the bibliographic record of each individual product. In this respect, such a collection is most often thought of as a series. A bibliographic collection may, however, also be traded as a single product (often thought of as a set), but this does not alter the way in which its collective attributes are described in the ONIX records for the individual products.

In other words, ONIX 3.0 doesn’t care whether a collection is most naturally thought of as a series or a set. If a fixed or indefinite number of products have a collective title and – possibly – other collective attributes that are required as part of the bibliographic record of each individual product, then those products are regarded as forming a collection.

ONIX 3.0 recognises two major types of collection: a publisher collection, and an ascribed collection. A publisher collection is one that is identified either on the products themselves or in product information originating from the publisher. An ascribed collection is one that is identified by another party in the information supply chain, usually an aggregator, for the benefit of retailers and consumers.

If the collection title, in full and word-for-word, is treated as part of the product title, then it will appear as part of <TitleDetail> in Group P.6, and the <Collection> composite is not usually needed. If the collection title is not treated as part of the product title, it must be sent in an instance of the <Collection> composite.

A product may (rarely) belong to two or more bibliographic collections. Consequently the collection-related elements constitute a repeatable composite.

Users should refer to the additional guidance and extensive examples to be found in a separate document ONIX for Books: Product Information Format: How to describe sets, series and multiple-item products.

Collection composite

An optional group of data elements which carry attributes of a collection of which the product is part. The composite is repeatable, to provide details when the product belongs to multiple collections.

Collection
collection
0…n
P.5.1 Collection type code

An ONIX code indicating the type of a collection: publisher collection, ascribed collection, or unspecified. Mandatory in each occurrence of the <Collection> composite, and non-repeating.

Fixed-length text, two digits
List 148
CollectionType
x329
1
<x329>10</x329> (Publisher collection)
P.5.2 Source name

If the <CollectionType> code indicates an ascribed collection (ie a collection which has been identified and described by a supply chain organization other than the publisher), this element may be used to carry the name of the organization responsible. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
SourceName
x330
0…1
<SourceName>Bowker</SourceName>
Collection identifier composite

A repeatable group of data elements which together specify an identifier of a bibliographic collection. The composite is optional, and may only repeat if two or more identifiers of different types are sent for the same collection. It is not permissible to have two identifiers of the same type.

CollectionIdentifier
collectionidentifier
0…n
P.5.3 Collection identifier type code

An ONIX code identifying a scheme from which an identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <CollectionIdentifier> composite, and non-repeating.

Fixed-length text, two digits
List 13
CollectionIDType
x344
1
<x344>02</x344> (ISSN)
P.5.4 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in <CollectionIDType> indicates a proprietary scheme, eg a publisher’s own code. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<b233>Springer</b233>
P.5.5 Identifier value

An identifier of the type specified in the <CollectionIDType> field. Mandatory in each occurrence of the <CollectionIdentifier> composite, and non-repeating.

According to the identifier type specified in <CollectionIDType>
IDValue
b244
1
<b244>12345678</b244>
End of Collection identifier composite
Collection sequence composite

An optional and repeatable group of data elements which indicates some ordinal position of a product within a collection. Different ordinal positions may be specified using separate repeats of the composite – for example, a product may be published first while also being third in narrative order within a collection.

CollectionSequence
collectionsequence
0…n
P.5.5a Collection sequence type

An ONIX code identifying the type of ordering used for the product’s sequence number within the collection. Mandatory and non-repeating within the <CollectionSequence> composite.

Fixed length, two digits
List 197
CollectionSequenceType
x479
1
<x479>03</x479> (Order of publication)
P.5.5b Collection sequence type name

A name which describes a proprietary order used for the product’s sequence number within the collection. Must be included when, and only when, the code in the <CollectionSequenceType> field indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
CollectionSequenceTypeName
x480
0…1
language
<x480>Order of TV series transmission</x480>
P.5.5c Collection sequence number

A number which specifies the ordinal position of the product in a collection. The ordinal position may be a simple number (1st, 2nd, 3rd etc) or may be multi-level (eg 3.2) if the collection has a multi-level structure (ie there are both collection and sub-collection title elements). Mandatory and non-repeating within the <CollectionSequence> composite.

New in 3.0.4 A hyphen may be used in place of an integer within a multi-level number, where a particular level of the hierarchy is unnumbered, for example -.3 where a product is the third in a sub-collection, and the sub-collection is unnumbered within the collection.

Variable length string of one or more positive integers or hyphens, each successive integer or hyphen being separated by a period character, suggested maximum length 50 characters
CollectionSequenceNumber
x481
1
<CollectionSequenceNumber>2.4</CollectionSequenceNumber>
End of Collection sequence composite
Title detail composite (collection)

A group of data elements which together give the text of a collection title and specify its type. Optional, but the composite is required unless the only collection title is carried in full, and word-for-word, as an integral part of the product title in P.6, in which case it should not be repeated in P.5. The composite is repeatable with different title types.

TitleDetail
titledetail
0…n
P.5.6 Title type code

An ONIX code indicating the type of a title. Mandatory in each occurrence of the <TitleDetail> composite, and non-repeating.

Fixed-length text, two digits
List 15
TitleType
b202
1
<TitleType>01</TitleType> (Distinctive title)
Title element composite (collection)

A group of data elements which together represent an element of a collection title. At least one title element is mandatory in each occurrence of the <TitleDetail> composite. The composite is repeatable with different sequence numbers and/or title element levels. An instance of the <TitleElement> composite must include at least one of: <PartNumber>; <YearOfAnnual>; <TitleText>, <NoPrefix/> together with <TitleWithoutPrefix>, or <TitlePrefix> together with <TitleWithoutPrefix>. In other words, it must carry either the text of a title element or a part or year designation, and it may carry both.

A title element must be designated as belonging to product level, collection level, or subcollection level (the first of these may not occur in a title element representing a collective identity, and the last-named may only occur in the case of a multi-level collection).

In the simplest case, title detail sent in a <Collection> composite will consist of a single title element, at collection level. However, the composite structure in ONIX 3.0 allows more complex combinations of titles and part designations in multi-level collections to be correctly represented.

TitleElement
titleelement
1…n
P.5.6a Title element sequence number

A number which specifies a single overall sequence of title elements, which is the preferred order for display of the various title elements when constructing a complete title. Optional and non-repeating. It is strongly recommended that each occurrence of the <TitleElement> composite should carry a <SequenceNumber>.

Positive integer, 1, 2, 3 etc, suggested maximum length 3 digits
SequenceNumber
b034
0…1
<b034>2</b034>
P.5.7 Title element level

An ONIX code indicating the level of a title element: collection level, subcollection level, or product level. Mandatory in each occurrence of the <TitleElement> composite, and non-repeating.

Fixed-length text, two digits
List 149
TitleElementLevel
x409
1
<x409>02</x409> (Collection level)
P.5.8 Part number

When a title element includes a part designation within a larger whole (eg Part I, or Volume 3), this field should be used to carry the number and its ‘caption’ as text. Optional and non-repeating.

Variable length text, suggested maximum 20 characters
PartNumber
x410
0…1
language, textscript
<PartNumber>Volume 17</PartNumber>
P.5.9 Year of annual

When the year of an annual is part of a title, this field should be used to carry the year (or, if required, a spread of years such as 2009–2010). Optional and non-repeating.

Year or range of years, in the format YYYY or YYYY-YYYY
YearOfAnnual
b020
0…1
<b020>2009</b020>
P.5.10 Title text

The text of a title element, excluding any subtitle. Optional and non-repeating, may only be used where <TitlePrefix>, <NoPrefix/> and <TitleWithoutPrefix> are not used.

This element is intended to be used only when the sending system cannot reliably provide prefixes that are ignored for sorting purposes in a separate data element. If the system can reliably separate prefixes, it should state whether a prefix is present (using <TitlePrefix> and <TitleWithoutPrefix>) or absent (using <NoPrefix/> and <TitleWithoutPrefix>).

Variable length text, suggested maximum 300 characters
TitleText
b203
0…1
collationkey, language, textscript, textcase
<b203 language="eng" textcase="01">Dickens classics</b203>
P.5.11 Title prefix

Text at the beginning of a title element which is to be ignored for alphabetical sorting. Optional and non-repeating; can only be used when <TitleText> is omitted, and if the <TitleWithoutPrefix> element is also present. These two elements may be used in combination in applications where it is necessary to distinguish an initial word or character string which is to be ignored for filing purposes, eg in library systems and in some bookshop databases.

Variable length text, suggested maximum 20 characters
TitlePrefix
b030
0…1
collationkey, language, textscript, textcase
<TitlePrefix language="eng">The</TitlePrefix>
P.5.11a “No prefix” indicator

An empty element that provides a positive indication that a title element does not include any prefix that is ignored for sorting purposes. Optional and non-repeating, and must only be used when <TitleWithoutPrefix> is used and no <TitlePrefix> element is present.

XML empty element
NoPrefix/
x501/
0…1
<NoPrefix/>
P.5.12 Title text without prefix

The text of a title element without the title prefix; and excluding any subtitle. Optional and non-repeating; can only be used if one of the <NoPrefix/> or <TitlePrefix> elements is also present.

Variable length text, suggested maximum 300 characters
TitleWithoutPrefix
b031
0…1
collationkey, language, textscript, textcase
<TitleWithoutPrefix language="eng" textcase="01">shameful life of Salvador Dali</TitleWithoutPrefix>
P.5.13 Subtitle

The text of a subtitle, if any. ‘Subtitle‘ means any added words which appear with the title element given in an occurrence of the <TitleElement> composite, and which amplify and explain the title element, but which are not considered to be part of the title element itself. Optional and non-repeating.

Variable length text, suggested maximum 300 characters
Subtitle
b029
0…1
collationkey, language, textscript, textcase
<Subtitle textcase="02">The Russian Revolution 1891–1924</Subtitle>
End of Title element composite (collection)
P.5.13a Collection title statement

Free text showing how the collection title should be presented in any display, particularly when a standard concatenation of individual title elements from Group P.5 (in the order specified by the <SequenceNumber> data elements) would not give a satisfactory result. Optional and non-repeating. When this field is sent, the recipient should use it to replace all collection title detail sent in Group P.5 for display purposes only. The individual collection title element detail must also be sent, for indexing and retrieval purposes.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
TitleStatement
x478
0…1
language, textformat
 
End of Title detail composite (collection)
Contributor composite (collection)

A group of data elements which together describe a personal or corporate contributor to a collection. Optional, and repeatable to describe multiple contributors. The <Contributor> composite is included here for use only by those ONIX communities whose national practice requires contributors to be identified at collection level. In many countries, including the UK, USA, Canada and Spain, the required practice is to identify all contributors at product level in Group P.7.

Contributor
contributor
0…n
P.5.14 to P.5.63a: elements in the Contributor composite

Elements P.5.14 to P.5.63a in the <Contributor> composite are identical to P.7.1 to P.7.50a as specified under Group P.7.

End of Contributor composite (collection)
P.5.63b Collection contributor statement

Free text showing how the collection authorship should be described in an online display, when a standard concatenation of individual collection contributor elements would not give a satisfactory presentation. Optional, and repeatable where parallel text is provided in multiple languages. The language attribute is optional for a single instance of <ContributorStatement>, but must be included in each instance if <ContributorStatement> is repeated. When the <ContributorStatement> element is sent, the recipient should use it to replace all name detail sent in the <Contributor> composites within <Collection> for display purposes only. It does not replace the <BiographicalNote> element (or any other element) for individual contributors. The individual name detail must also be sent in one or more <Contributor> composites for indexing and retrieval purposes.

The <ContributorStatement> element is provided here for use only by those ONIX communities whose national practice requires contributors to be identified at collection level. It should not be sent in a context where collection contributors are normally identified in Group P.6.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
ContributorStatement
b049
0…n
language, textformat
<b049>Series conceived and edited by Samantha and Darrin Stephens</b049>
P.5.63c “No authorship” indicator

An empty element that provides a positive indication that a collection has no stated authorship. Optional and non-repeating. Must only be sent in a record that has no <Contributor> data in Group P.5.

The <NoContributor/> element is provided here for use only by those ONIX communities whose national practice requires contributors to be identified at collection level. It should not be sent in a context where collection contributors are normally identified in Group P.6.

XML empty element
NoContributor/
n339/
0…1
<NoContributor/>
End of Collection composite
P.5.64 “No collection” indicator

An empty element that provides a positive indication that a product does not belong to a collection (a ‘set’ or ‘series’). This element is intended to be used in an ONIX accreditation scheme to confirm that collection information is being consistently supplied in publisher ONIX feeds. Optional and non-repeating. Must only be sent in a record that has no instances of the <Collection> composite and has no collection level title elements in Group P.6.

XML empty element
NoCollection/
x411/
0…1
<NoCollection/>

P.6 Product title detail

Group P.6 carries the title or titles of the product described in the ONIX record, and includes the primary occurrence of the <TitleDetail> composite, which is also used in Group P.5. The purpose of this extended title composite in ONIX 3.0 is to make it possible to deliver a distinctive title for a product when that title includes elements relating to a collection (as defined in P.5), or what is commonly referred to as a series. By structuring a complex title in this way, it is possible to identify correctly the collection level and product level elements, and to deliver them in whatever is the publisher’s preferred arrangement (eg ‘A Game of Thrones: A Song of Ice and Fire, Book 1’, where the collection-level title follows the product-level title).

For more information on the handling of complex titles, users should refer to the additional guidance and extensive examples to be found in a separate document ONIX for Books: Product Information Format: How to describe sets, series and multiple-item products.

An example of how a simple title is represented in the new structure appears at the end of this section.

Title detail composite

A group of data elements which together give the text of a title and specify its type. At least one title detail element is mandatory in each occurrence of the <DescriptiveDetail> composite, to give the primary form of the product title. The composite is repeatable with different title types.

TitleDetail
titledetail
1…n
P.6.1 Title type code

An ONIX code indicating the type of a title. Mandatory in each occurrence of the <TitleDetail> composite, and non-repeating.

Fixed length, two digits
List 15
TitleType
b202
1
<TitleType>01<TitleType> (Distinctive title)
Title element composite

A group of data elements which together represent an element of a title. At least one title element is mandatory in each occurrence of the <TitleDetail> composite. The composite is repeatable with different sequence numbers and/or title element levels, each repeat carrying a different part of the title. An instance of the <TitleElement> composite must include at least one of: <PartNumber>; <YearOfAnnual>; <TitleText>, <NoPrefix/> together with <TitleWithoutPrefix>, or <TitlePrefix> together with <TitleWithoutPrefix>. In other words it must carry either the text of a title or a part or year designation, and it may carry both.

A title element must be designated as belonging to product level, collection level, or subcollection level (the last-named only in the case of a multi-level collection).

In the simplest case, a product title will consist of a single title element, at product level. However, the composite structure in ONIX 3.0 allows complex titles to be correctly represented, in the sequence in which the publisher wishes the elements to be displayed.

TitleElement
titleelement
1…n
P.6.1a Title element sequence number

A number which specifies a single overall sequence of title elements, which is the preferred order for display of the various title elements when constructing a complete title. Optional and non-repeating. It is strongly recommended that where there are multiple title elements within a <TitleDetail> composite, each occurrence of the <TitleElement> composite should carry a <SequenceNumber>.

Positive integer, 1, 2, 3 etc, suggested maximum length 3 digits
SequenceNumber
b034
0…1
<b034>2</b034>
P.6.2 Title element level

An ONIX code indicating the level of a title element: collection level, subcollection level, or product level. Mandatory in each occurrence of the <TitleElement> composite, and non-repeating.

Fixed length, two digits
List 149
TitleElementLevel
x409
1
<x409>02</x409> (Collection level)
P.6.3 Part number

When a title element includes a part designation within a larger whole (eg Part I, or Volume 3), this field should be used to carry the number and its ‘caption’ as text. Optional and non-repeating.

Variable length text, suggested maximum 20 characters
PartNumber
x410
0…1
language, textscript
<x410>Volume 17</x410>
P.6.4 Year of annual

When the year of an annual is part of a title, this field should be used to carry the year (or, if required, a spread of years such as 2009–2010). Optional and non-repeating.

Year or range of years, in the format YYYY or YYYY-YYYY
YearOfAnnual
b020
0…1
<b020>2009</b020>
P.6.5 Title text

The text of a title element, excluding any subtitle. Optional and non-repeating, may only be used where <TitlePrefix>, <NoPrefix/> and <TitleWithoutPrefix> are not used.

This element is intended to be used only when the sending system cannot reliably provide prefixes that are ignored for sorting purposes in a separate data element. If the system can reliably separate prefixes, it should state whether a prefix is present (using <TitlePrefix> and <TitleWithoutPrefix>) or absent (using <NoPrefix/> and <TitleWithoutPrefix>).

Variable length text, suggested maximum 300 characters
TitleText
b203
0…1
collationkey, language, textscript, textcase
<b203>Nicholas Nickleby</b203>
P.6.6 Title prefix

Text at the beginning of a title element which is to be ignored for alphabetical sorting. Optional and non-repeating; can only be used when <TitleText> is omitted, and if the <TitleWithoutPrefix> element is also present. These two elements may be used in combination in applications where it is necessary to distinguish an initial word or character string which is to be ignored for filing purposes, eg in library systems and in some bookshop databases.

Variable length text, suggested maximum 20 characters
TitlePrefix
b030
0…1
collationkey, language, textscript, textcase
<TitlePrefix textcase="01">The</TitlePrefix>
P.6.6a “No prefix” indicator

An empty element that provides a positive indication that a title element does not include any prefix that is ignored for sorting purposes. Optional and non-repeating, and must only be used when <TitleWithoutPrefix> is used and no <TitlePrefix> element is present.

XML empty element
NoPrefix/
x501/
0…1
<NoPrefix/>
P.6.7 Title without prefix

The text of a title element without the title prefix; and excluding any subtitle. Optional and non-repeating; can only be used if one of the <NoPrefix/> or <TitlePrefix> elements is also present.

Variable length text, suggested maximum 300 characters
TitleWithoutPrefix
b031
0…1
collationkey, language, textscript, textcase
<TitleWithoutPrefix textcase="01">shameful life of Salvador Dali</TitleWithoutPrefix> (text is in sentence case)
P.6.8 Subtitle

The text of a subtitle, if any. ‘Subtitle’ means any added words which appear with the title element given in an occurrence of the <TitleElement> composite, and which amplify and explain the title element, but which are not considered to be part of the title element itself. Optional and non-repeating.

Variable length text, suggested maximum 300 characters
Subtitle
b029
0…1
collationkey, language, textscript, textcase
<b029 textcase="02">The Russian Revolution 1891–1924</b029> (text is in title case)
End of Title element composite
P.6.8a Title statement

Free text showing how the overall title (including any collection level title, if the collection title is treated as part of the product title and included in P.6) should be presented in any display, particularly when a standard concatenation of individual title elements from Group P.6 (in the order specified by the <SequenceNumber> data elements) would not give a satisfactory result. Optional and non-repeating. When this field is sent, the recipient should use it to replace all title detail sent in Group P.6 for display purposes only. The individual title element detail must also be sent, for indexing and retrieval purposes.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
TitleStatement
x478
0…1
language, textformat
<TitleStatement>Granta – the magazine of new writing: The Best of Young Spanish Language Novelists</TitleStatement>
End of Title detail composite
<TitleDetail> composite for a ‘simple’ product title
using Reference names, title as a single text string
<NoCollection/>For confirmation
<TitleDetail>
    <TitleType>01<TitleType>Distinctive title
    <TitleElement>
        <TitleElementLevel>01</TitleElementLevel>Product level
        <TitleText textcase="01">The all-true travels and adventures of Lidie Newton</TitleText>Sentence case
    </TitleElement>
</TitleDetail>
using Short tags, with prefix and remainder of title text separate
<x411/>
<titledetail>
    <b202>01<b202>
    <titleelement>
        <x409>01</x409>
        <b030 textcase="02">The</b030>Title case
        <b031 textcase="02">All-True Travels and Adventures of Lidie Newton</b031>Without prefix
    </titleelement>
</titledetail>
<TitleDetail> composite for a more ‘complex’ product title
using Reference names, with collection level title and subtitle
<TitleDetail>
    <TitleType>01</TitleType>Distinctive title
    <TitleElement>
        <TitleElementLevel>02</TitleElementLevel>Collection level
        <TitleText textcase="02">Granta</TitleText>Title case
        <Subtitle textcase="01">The magazine of new writing</Subtitle>Sentence case
    </TitleElement>
    <TitleElement>
        <TitleElementLevel>01</TitleElementLevel>Product level
        <PartNumber>113</PartNumber>
        <TitlePrefix textcase="02">The</TitlePrefix>
        <TitleWithoutPrefix textcase="02">Best of Young Spanish Language Novelists​</TitleWithoutPrefix>
    </TitleElement>
    <TitleStatement>Granta – the magazine of new writing: The Best of Young Spanish Language Novelists​</TitleStatement>
</TitleDetail>
using Short tags, and with additional alternative language title
<titledetail>
    <b202>01</b202>Distinctive title
    <titleelement>
        <x409>02</x409>Collection level
        <b203 textcase="02">Granta</b203>
        <b029 textcase="01">The magazine of new writing</b029>
    </titleelement>
    <titleelement>
        <x409>01</x409>Product level
        <x410>113</x410>
        <b030 textcase="02">The</b030>
        <b031 textcase="02">Best of Young Spanish Language Novelists​</b031>
    </titleelement>
    <x478>Granta – the magazine of new writing: The Best of Young Spanish Language Novelists​</x478>
</titledetail>
<titledetail>
    <b202>11</b202>Alternative title
    <titleelement>
        <x409>01</x409>Product level
        <b030 language="spa" textcase="02">Los</b203>Title in Spanish
        <b031 language="spa" textcase="02">Mejores Narradores Jóvenes en Español</b203>
    </titleelement>
</titledetail>
P.6.9 Thesis type code

An ONIX code identifying a thesis type, when the ONIX record describes an item which was originally presented as an academic thesis or dissertation. Optional and non-repeating.

Fixed length, two digits
List 72
ThesisType
b368
0…1
<b368>01</b368> (Habilitationsschrift, post-doctoral dissertation)
P.6.10 Thesis presented to

The name of an academic institution to which a thesis was presented. Optional and non-repeating, but if this element is present, <ThesisType> must also be present.

Variable length text, suggested maximum length 300 characters
ThesisPresentedTo
b369
0…1
language
 
P.6.11 Year of thesis

The year in which a thesis was presented. Optional and non-repeating, but if this element is present, <ThesisType> must also be present.

As specified by the value in the dateformat attribute, or the default of YYYY if the attribute is missing
ThesisYear
b370
0…1
dateformat
<ThesisYear>2002</ThesisYear>

P.7 Authorship

Authorship and other forms of contribution are described by repeats of the <Contributor> composite, within which the recommended form of representation of a person name is the structured data element group consisting of Person name part 1 to Person name part 8. In addition, more than one representation of the same name may be sent: the preferred structured name may be supplemented or replaced by a simple <PersonName> and/or <PersonNameInverted>. Where the contributor is not a person, but is a named group or a corporate contributor, <CorporateName> and/or <CorporateNameInverted> must be used instead.

A single occurrence of the composite may carry both the primary name of a contributor, and one or more alternative names, for example if a contributor is referenced both by their real name and by a pseudonym, or by the name given on the title page and by an authority-controlled name.

A contributor composite is valid in terms of the XML Schema or DTD provided it contains at least a <ContributorRole> code and:

  • one or more of the forms of representation of a person name, with or without an occurrence of the <NameIdentifier> composite; or
  • one or both of the forms of representation of a corporate name, with or without an occurrence of the <NameIdentifier> composite; or
  • an <UnnamedPersons> element, with or without an occurrence of the <NameIdentifier> composite; or
  • an occurrence of the <NameIdentifier> composite without any accompanying name element(s).

Other elements are optional, except that neither <Gender> nor <ProfessionalAffiliation> should be used with corporate contributors.

The <ContributorStatement> element may be used to provide a free text statement of the whole of the authorship of the product in the form in which the publisher intends it to be displayed. The individual name detail must still be sent in the <Contributor> composite for indexing and retrieval.

An optional element <NoContributor/> may be used to make a positive statement in an ONIX record that the item has no credited authorship.

Contributor composite

A group of data elements which together describe a personal or corporate contributor to the product. Optional, and repeatable to describe multiple contributors.

Contributor
contributor
0…n
P.7.1 Contributor sequence number

A number which specifies a single overall sequence of contributor names. Optional and non-repeating. It is strongly recommended that each occurrence of the <Contributor> composite should carry a <SequenceNumber>.

Positive integer, 1, 2, 3 etc, suggested maximum length 3 digits
SequenceNumber
b034
0…1
<b034>3</b034>
P.7.2 Contributor role

An ONIX code indicating the role played by a person or corporate body in the creation of the product. Mandatory in each occurrence of a <Contributor> composite, and may be repeated if the same person or corporate body has more than one role in relation to the product.

Fixed length, one letter and two digits
List 17
ContributorRole
b035
1…n
<b035>A01</b035> (Written by)
P.7.3 Source language of a translation

Used only when the <ContributorRole> code value is B06, B08 or B10 indicating a translator, to specify the source language from which the translation was made. This element makes it possible to specify a translator’s exact responsibility when a work involves translation from two or more languages. Optional, and repeatable in the event that a single person has been responsible for translation from two or more languages.

Fixed length, three lower-case letters. Note that ISO 639 specifies that these codes should always be in lower-case
ISO 639-2/B List 74
FromLanguage
x412
0…n
<FromLanguage>eng</FromLanguage>
P.7.4 Target language of a translation

Used only when the <ContributorRole> code value is B06, B08 or B10 indicating a translator, to specify the target language into which the translation was made. This element makes it possible to specify a translator’s exact responsibility when a work involves translation into two or more languages. Optional, and repeatable in the event that a single person has been responsible for translation to two or more languages.

Fixed length, three lower-case letters. Note that ISO 639 specifies that these codes should always be in lower-case
ISO 639-2/B List 74
ToLanguage
x413
0…n
<x413>swe</x413>
P.7.5 Primary name type

An ONIX code indicating the type of a primary name. Optional, and non-repeating. If omitted, the default is ‘unspecified’.

Fixed length, two digits
List 18
NameType
x414
0…1
<NameType>01</NameType> (Pseudonym)
Name identifier composite

A group of data elements which together specify a name identifier, used here to carry an identifier for a person or organization name given in an occurrence of the <Contributor> composite. Optional: see Group P.7 introductory text for valid options. Repeatable to specify name identifiers of different types for the same person or organization name.

NameIdentifier
nameidentifier
0…n
P.7.6 Name identifier type

An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <NameIdentifier> composite, and non-repeating.

Fixed length, two digits
List 44
NameIDType
x415
1
<x415>01</x415> (Proprietary)
P.7.7 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <NameIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<b233>BigPublisher Internal Author ID</b233>
P.7.8 Identifier value

A code value taken from the scheme specified in the <NameIDType> element. Mandatory in each occurrence of the composite, and non-repeating.

Determined by the scheme specified in <NameIDType>
IDValue
b244
1
<b244>7148</b244>
End of Name identifier composite
supplying an ISNI and the publisher’s internal contributor ID
using Reference names
<NameIdentifier>
    <NameIDType>01</NameIDType>
    <IDTypeName>XYZ Author ID</IDTypeName>
    <IDValue>580</IDValue>
</NameIdentifier>
<NameIdentifier>
    <NameIDType>16</NameIDType>
    <IDValue>0000000068287141</IDValue>
</NameIdentifier>
using Short tags
<nameidentifier>
    <x415>01</x415>Proprietary list
    <b233>XYZ Author ID</b233>Name of list
    <b244>580</b244>
</nameidentifier>
<nameidentifier>
    <x415>16</x415>ISNI
    <b244>0000000068287141</b244>
</nameidentifier>
P.7.9 Person name

The name of a person who contributed to the creation of the product, unstructured, and presented in normal order. Optional and non-repeating: see Group P.7 introductory text for valid options.

Variable length text, suggested maximum length 100 characters
PersonName
b036
0…1
collationkey, language, textscript
<PersonName>James J. Johnson III</PersonName>
P.7.10 Person name, inverted

The name of a person who contributed to the creation of the product, presented with the element used for alphabetical sorting placed first (‘inverted order’). Optional and non-repeating: see Group P.7 introductory text for valid options.

Variable length text, suggested maximum length 100 characters
PersonNameInverted
b037
0…1
collationkey, language, textscript
<b037>Johnson, James J., III</b037>
P.7.11 Person name part 1: titles before names

The first part of a structured name of a person who contributed to the creation of the product: qualifications and/or titles preceding a person’s names, eg ‘Professor’ or ‘HRH Prince’ or ‘Saint’. Optional and non-repeating: see Group P.7 introductory text for valid options.

Variable length text, suggested maximum length 100 characters
TitlesBeforeNames
b038
0…1
collationkey, language, textscript
<TitlesBeforeNames>HRH Prince</TitlesBeforeNames>
P.7.12 Person name part 2: names before key names

The second part of a structured name of a person who contributed to the creation of the product: name(s) and/or initial(s) preceding a person’s key name(s), eg James J. Optional and non-repeating.

Variable length text, suggested maximum length 100 characters
NamesBeforeKey
b039
0…1
collationkey, language, textscript
<b039>James J.</b039>
P.7.13 Person name part 3: prefix to key names

The third part of a structured name of a person who contributed to the creation of the product: a prefix which precedes the key name(s) but which is not to be treated as part of the key name, eg ‘van’ in Ludwig van Beethoven. This element may also be used for titles that appear after given names and before key names, eg ‘Lord’ in Alfred, Lord Tennyson. Optional and non-repeating.

Variable length text, suggested maximum length 100 characters
PrefixToKey
b247
0…1
collationkey, language, textscript
<PrefixToKey>van</PrefixToKey>
P.7.14 Person name part 4: key name(s)

The fourth part of a structured name of a person who contributed to the creation of the product: key name(s), ie the name elements normally used to open an entry in an alphabetical list, eg ‘Smith’ or ‘Garcia Marquez’ or ‘Madonna’ or ‘Francis de Sales’ (in Saint Francis de Sales). Non-repeating. Required if name part elements P.7.11 to P.7.18 are used.

Variable length text, suggested maximum length 100 characters
KeyNames
b040
0…1
collationkey, language, textscript
<b040>Beethoven</b040>
P.7.15 Person name part 5: names after key names

The fifth part of a structured name of a person who contributed to the creation of the product: name suffix, or name(s) following a person’s key name(s), eg ‘Ibrahim’ (in Anwar Ibrahim). Optional and non-repeating.

Variable length text, suggested maximum length 100 characters
NamesAfterKey
b041
0…1
collationkey, language, textscript
<b041>Ibrahim</b041>
P.7.16 Person name part 6: suffix after key names

The sixth part of a structured name of a person who contributed to the creation of the product: a suffix following a person’s key name(s), eg ‘Jr’ or ‘III’. Optional and non-repeating.

Variable length text, suggested maximum length 100 characters
SuffixToKey
b248
0…1
collationkey, language, textscript
<SuffixToKey>Jr.</SuffixToKey>
P.7.17 Person name part 7: qualifications and honors after names

The seventh part of a structured name of a person who contributed to the creation of the product: qualifications and honors following a person’s names, eg ‘CBE FRS’. Optional and non-repeating.

Variable length text, suggested maximum length 100 characters
LettersAfterNames
b042
0…1
collationkey, language, textscript
<b042>MB FRCS</b042>
P.7.18 Person name part 8: titles after names

The eighth part of a structured name of a person who contributed to the creation of the product: titles following a person’s names, eg ‘Duke of Edinburgh’. Optional and non-repeating.

Variable length text, suggested maximum length 100 characters
TitlesAfterNames
b043
0…1
collationkey, language, textscript
<TitlesAfterNames>Duke of Edinburgh</TitlesAfterNames>
P.7.18a Contributor gender

An optional ONIX code specifying the gender of a personal contributor. Not repeatable. Note that this indicates the gender of the contributor’s public identity (which may be pseudonymous) based on designations used in ISO 5218, rather than the gender identity, biological sex or sexuality of a natural person.

Fixed length, single character
List 229
Gender
x524
0…1
<x524>f</x524> (public identity is female)
P.7.19 Corporate contributor name

The name of a corporate body which contributed to the creation of the product, unstructured. Optional and non-repeating: see Group P.7 introductory text for valid options.

Variable length text, suggested maximum length 200 characters
CorporateName
b047
0…1
collationkey, language, textscript
<CorporateName>Good Housekeeping Institute</CorporateName>
P.7.20 Corporate contributor name, inverted

The name of a corporate body which contributed to the creation of the product, presented in inverted order, with the element used for alphabetical sorting placed first. Optional and non-repeating: see Group P.7 introductory text for valid options.

Variable length text, suggested maximum length 200 characters
CorporateNameInverted
x443
0…1
collationkey, language, textscript
<x443>Countryside Commission, The</x443>
P.7.20a Unnamed person(s)

An ONIX code allowing a positive indication to be given when authorship is unknown or anonymous, or when as a matter of editorial policy only a limited number of contributors are named. Optional and non-repeating: see Group P.7 introductory text for valid options. Use here in preference to P.7.47, where it is deprecated.

Fixed length, two digits
List 19
UnnamedPersons
b249
0…1
<b249>02</b249> (Anonymous)
Alternative name composite

A group of data elements which together represent an alternative name of a contributor, and specify its type. The <AlternativeName> composite is optional, and is repeatable to give multiple alternative names for the contributor. It may be used to send a pseudonym as well as a real name, where both names are on the product, eg to handle such cases as ‘Ian Rankin writing as Jack Harvey’; or to send an authority-controlled form of a name; or to identify the real name of the contributor where the book is written under a pseudonym (and the real identity need not be kept private) or is anonymous. Note that in all cases, the primary name is that used on the product, and the alternative name merely provides additional information.

Each instance of the composite must contain the <NameType> element with either:

  • one or more of the forms of representation of a person name, with or without an occurrence of the <NameIdentifier> composite; or
  • one or both of the forms of representation of a corporate name, with or without an occurrence of the <NameIdentifier> composite; or
  • an occurrence of the <NameIdentifier> composite without any accompanying name element(s).
AlternativeName
alternativename
0…n
P.7.21 Alternative name type

An ONIX code indicating the type of the name sent in an occurrence of the <AlternativeName> composite. Mandatory in each occurrence of the composite, and non-repeating.

Fixed length, two digits
List 18
NameType
x414
1
<x414>01</x414> (Pseudonym)
P.7.22 to P.7.36: other elements in the Alternative name composite

Elements P.7.22 to P.7.36 in the <AlternativeName> composite are identical to P.7.6 to P.7.20 as specified on preceding pages.

End of Alternative name composite
George Orwell was the pen name of Eric Blair
using Reference names
<Contributor>
    <SequenceNumber>1</SequenceNumber>
    <ContributorRole>A01</ContributorRole>Author
    <NamesBeforeKey>George</NamesBeforeKey>George Orwell
    <KeyNames>Orwell</KeyNames>
    <AlternativeName>
        <NameType>04</NameType>Real name
        <NamesBeforeKey>Eric</NamesBeforeKey>Eric Blair
        <KeyNames>Blair</KeyNames>
    </AlternativeName>
</Contributor>
using Short tags
<contributor>
    <b034>1</b034>
    <b035>A01</b035>
    <b039>George</b039>
    <b040>Orwell</b040>
    <alternativename>
        <x414>04</x414>
        <b039>Eric</b039>
        <b040>Blair</b040>
    </alternativename>
</contributor>
‘writing as’ – both names are on book
using Reference names
<Contributor>
    <SequenceNumber>1</SequenceNumber>
    <ContributorRole>A01</ContributorRole>Author
    <NamesBeforeKey>Ian</NamesBeforeKey>Ian Rankin
    <KeyNames>Rankin</KeyNames>
    <AlternativeName>
        <NameType>01</NameType>Pseudonym
        <NamesBeforeKey>Jack</NamesBeforeKey>Jack Harvey
        <KeyNames>Harvey</KeyNames>
    </AlternativeName>
</Contributor>
using Short tags
<contributor>
    <b034>1</b034>
    <b035>A01</b035>
    <b039>Ian</b039>
    <b040>Rankin</b040>
    <alternativename>
        <x414>01</x414>
        <b039>Jack</b039>
        <b040>Harvey</b040>
    </alternativename>
</contributor>
Contributor date composite

A group of data elements which together specify a date associated with the person or organization identified in an occurrence of the <Contributor> composite, eg birth or death. Optional, and repeatable to allow multiple dates to be specified.

ContributorDate
contributordate
0…n
P.7.37 Contributor date role code

An ONIX code indicating the significance of the date in relation to the contributor name. Mandatory in each occurrence of the <ContributorDate> composite, and non-repeating.

Fixed length, two digits
List 177
ContributorDateRole
x417
1
<ContributorDateRole>50</ContributorDateRole> (Date of birth)
P.7.38 Date format

An ONIX code indicating the format in which the date is given in <Date>. Optional and not repeatable. Deprecated – where possible, use the dateformat attribute instead.

Fixed length, two digits
List 55
DateFormat
j260
0…1
<DateFormat>05</DateFormat> (YYYY)
P.7.39 Date

The date specified in the <ContributorDateRole> field. Mandatory in each occurrence of the <ContributorDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then <DateFormat> indicates the format of the date; if both dateformat attribute and <DateFormat> element are missing, the default format is YYYYMMDD.

As specified by the value in the dateformat attribute, in <DateFormat>, or the default YYYYMMDD
Date
b306
1
dateformat
<Date>20010106</Date>
End of Contributor date composite
Professional affiliation composite

An optional group of data elements which together identify a contributor’s professional position and/or affiliation, repeatable to allow multiple positions and affiliations to be specified.

ProfessionalAffiliation
professionalaffiliation
0…n
P.7.40 Professional position

A professional position held by a contributor to the product at the time of its creation. Optional, and repeatable to provide parallel text in multiple languages. The language attribute is optional for a single instance of <ProfessionalPosition>, but must be included in each instance if <ProfessionalPosition> is repeated.

Variable length text, suggested maximum length 100 characters
ProfessionalPosition
b045
0…n
language
<b045>Humboldt Professor of Oceanography</b045>
P.7.41 Affiliation

An organization to which a contributor to the product was affiliated at the time of its creation, and – if the <ProfessionalPosition> element is also present – where s/he held that position. Optional and non-repeating.

Variable length text, suggested maximum length 200 characters
Affiliation
b046
0…1
language
<b046 language="spa">Universidad de La Laguna</b046>
End of Professional affiliation composite
Prize composite

An optional group of data elements which together describe a prize or award won by the contributor for a body of work (rather than for this or other specific works or products). Repeatable to describe multiple prizes or awards.

Prize
prize
0…n
P.7.41a to P.7.41f: elements in the Prize composite

Elements P.7.41a to P.7.41f in the <Prize> composite are identical to P.17.1 and P.17.5 as specified in Group P.17.

End of Prize composite
P.7.42 Biographical note

A biographical note about a contributor to the product. (See the <TextContent> composite in Group P.14 for a biographical note covering all contributors to a product in a single text.) Optional, and repeatable to provide parallel biographical notes in multiple languages. The language attribute is optional for a single instance of <BiographicalNote>, but must be included in each instance if <BiographicalNote> is repeated. May occur with a person name or with a corporate name. A biographical note in ONIX should always contain the name of the person or body concerned, and it should always be presented as a piece of continuous text consisting of full sentences. Some recipients of ONIX data feeds will not accept text which has embedded URLs. A contributor website link can be sent using the <Website> composite below.

Variable length text, no suggested maximum length (since there is no suggested length for the text in a <TextContent> composite, where a biographical note can alternatively be sent). XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
BiographicalNote
b044
0…n
language, textformat
<b044 language="eng" textformat="05"><p><strong>Umberto Eco</strong>, professor of semiotics at the University of Bologna, and author of <cite>The Name Of The Rose</cite> and <cite>Foucault’s Pendulum</cite>, is one of the world’s bestselling novelists.</p><p>As well as novels, he also writes children’s books and academic works.</p></b044>
<b044 language="ita" textformat="05"><p><strong>Umberto Eco</strong>, professore di semiotica all’Università di Bologna e autore di <cite>Il nome della rosa</cite> e <cite>Il pendolo di Foucault</cite>, è uno dei romanzieri più venduto al mondo.</p><p>Così come romanzi, lui scrive anche libri per bambini e opere accademici.</p></b044> (text is marked up with XHTML, and both English and Italian versions are provided)
<b044>Umberto Eco, professor of semiotics at the University of Bologna, and author of ‘The Name Of The Rose’ and ‘Foucault’s Pendulum’, is one of the world’s bestselling novelists. As well as novels, he also writes children’s books and academic works.</b044> (text is not marked up)
Beware of biographical notes including phrases such as ‘her latest work is…’, as they are somewhat time-sensitive, and consider the use of the datestamp attribute if such phrases cannot be avoided.
Website composite

An optional group of data elements which together identify and provide a pointer to a website which is related to the person or organization identified in an occurrence of the <Contributor> composite. Repeatable to provide links to multiple websites.

Website
website
0…n
P.7.43 Website purpose

An ONIX code which identifies the role or purpose of the website which is linked through the <WebsiteLink> element. Optional and non-repeating.

Fixed length, two digits
List 73
WebsiteRole
b367
0…1
<b367>07</b367> (Publisher’s website relating to specified contributor)
P.7.44 Website description

Free text describing the nature of the website which is linked through the <WebsiteLink> element. Optional, and repeatable to provide parallel descriptive text in multiple languages. The language attribute is optional for a single instance of <WebsiteDescription>, but must be included in each instance if <WebsiteDescription> is repeated.

Variable length text, suggested maximum length 300 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
WebsiteDescription
b294
0…n
language, textformat
<b294>Includes author bio, gallery of photos, interview, complete bibliography and links to download book covers as mobile phone wallpapers</b294>
End of Website composite
using Reference names
<Website>
    <WebsiteRole>06</WebsiteRole>
    <WebsiteLink>https://www.jkrowling.com/</WebsiteLink>
</Website>
using Short tags
<website>
    <b367>06</b367>Contributor’s own website
    <b295>https://www.jkrowling.com/</b295>
</website>
P.7.46 Contributor description

Brief text describing a contributor to the product, at the publisher’s discretion. Optional, and repeatable to provide parallel descriptions in multiple languages. The language attribute is optional for a single instance of <ContributorDescription>, but must be included in each instance if <ContributorDescription> is repeated. It may be used with either a person or corporate name, to draw attention to any aspect of a contributor’s background which supports the promotion of the book.

Variable length text, suggested maximum length 200 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
ContributorDescription
b048
0…n
language, textformat
<ContributorDescription>Skipper of the winning crew in the Americas Cup, 1998</ContributorDescription>
P.7.47 Unnamed person(s)

An ONIX code allowing a positive indication to be given when authorship is unknown or anonymous, or when as a matter of editorial policy only a limited number of contributors are named. Optional and non-repeating: see Group P.7 introductory text for valid options. Deprecated here – where possible, use P.7.20a instead. If used here, may not be combined with <NameIdentifier> or <AlternativeName>.

Fixed length, two digits
List 19
UnnamedPersons
b249
0…1
<b249>02</b249> (Anonymous)
Contributor place composite

An optional group of data elements which together identify a geographical location with which a contributor is associated, used to support ‘local interest’ promotions. Repeatable to identify multiple geographical locations, each usually with a different relationship to the contributor.

ContributorPlace
contributorplace
0…n
P.7.48 Contributor place relator

An ONIX code identifying the relationship between a contributor and a geographical location. Mandatory in each occurrence of <ContributorPlace> and non-repeating.

Fixed length, two digits
List 151
ContributorPlaceRelator
x418
1
<x418>01</x418> (Born in)
P.7.49 Country code

A code identifying a country with which a contributor is particularly associated. Optional and non-repeatable. There must be an occurrence of either the <CountryCode> or the <RegionCode> elements in each occurrence of <ContributorPlace>.

Fixed length, two letters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes List 91
CountryCode
b251
0…1
<CountryCode>US</CountryCode>
P.7.50 Region code

An ONIX code identifying a region with which a contributor is particularly associated. Optional and non-repeatable. There must be an occurrence of either the <CountryCode> or the <RegionCode> elements in each occurrence of <ContributorPlace>. A region is an area which is not a country, but which is precisely defined in geographical terms, eg Northern Ireland, Australian Capital Territory. If both country and region are specified, the region must be within the country. Note that US States have region codes, while US overseas territories have distinct ISO Country Codes.

Variable length code, consisting of upper case letters, with or without a hyphen and further upper case letters or digits. Suggested maximum length 8 characters
List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166-2
RegionCode
b398
0…1
<RegionCode>CA-NL</RegionCode> (Newfoundland and Labrador)
P.7.50a Location name

The name of a city or town location within the specified country or region with which a contributor is particularly associated. Optional, and repeatable to provide parallel names for a single location in multiple languages (eg Baile Átha Cliath and Dublin, or Bruxelles and Brussel). The language attribute is optional for a single instance of <LocationName>, but must be included in each instance if <LocationName> is repeated.

Variable length text, suggested maximum length 100 characters
LocationName
j349
0…n
language
<j349>Stephenville</j349>
End of Contributor place composite
End of Contributor composite
P.7.51 Contributor statement

Free text showing how the authorship should be described in an online display, when a standard concatenation of individual contributor elements would not give a satisfactory presentation. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <ContributorStatement>, but must be included in each instance if <ContributorStatement> is repeated. When the <ContributorStatement> field is sent, the receiver should use it to replace all name detail sent in the <Contributor> composite for display purposes only. It does not replace the <BiographicalNote> element. The individual name detail must also be sent in the <Contributor> composite for indexing and retrieval purposes.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
ContributorStatement
b049
0…n
language, textformat
<b049>Written and illustrated by Fred and Emily Jackson</b049>
P.7.52 “No authorship” indicator

An empty element that provides a positive indication that a product has no stated authorship. Intended to be used in an ONIX accreditation scheme to confirm that author information is being consistently supplied in publisher ONIX feeds. Optional and non-repeating. Must only be sent in a record that has no other elements from Group P.7.

XML empty element
NoContributor/
n339/
0…1
<NoContributor/>

P.8 Event

Data element Group P.8 describes an event or multiple events to which the product is related.

Note this Group was formerly known as P.8 Conference. The <Conference> composite is now deprecated and a more flexible replacement <Event> composite has been added.

Conference composite

A group of data elements which together describe a conference to which the product is related. Optional, and repeatable if the product contains material from two or more conferences.

The whole of the <Conference> composite is deprecated, in favor of the <Event> composite which has an equivalent structure.

Conference
conference
0…n
P.8.1 Conference role

An ONIX code which indicates the relationship between the product and a conference to which it is related, eg Proceedings of / Selected papers from / Developed from. Optional and non-repeating.

Fixed length, two digits
List 20 (only code 01 may be used)
ConferenceRole
b051
0…1
 
P.8.2 Conference name

The name of a conference or conference series to which the product is related. This element is mandatory in each occurrence of the <Conference> composite, and non-repeating.

Variable length text, suggested maximum length 200 characters
ConferenceName
b052
1
language
<b052>United Nations Climate Change Conference</b052>
P.8.3 Conference acronym

An acronym used as a short form of the name of a conference or conference series given in the <ConferenceName> element. Optional and non-repeating.

Variable length text, suggested maximum length 20 characters
ConferenceAcronym
b341
0…1
language
<ConferenceAcronym>UNFCCC COP17</ConferenceAcronym>
P.8.4 Conference number

The number of a conference to which the product is related, within a conference series. Optional and non-repeating.

Positive integer, suggested maximum length 4 digits
ConferenceNumber
b053
0…1
<b053>22</b053>
P.8.5 Conference thematic title

The thematic title of an individual conference in a series that has a conference series name in the <ConferenceName> element. Optional and non-repeating.

Variable length text, suggested maximum length 200 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields – but is strongly discouraged
ConferenceTheme
b342
0…1
language, textformat
 
P.8.6 Conference date

The date of a conference to which the product is related. Optional and non-repeating.

As specified by the value in the dateformat attribute, or the default of YYYY if the attribute is missing. Note that the dateformat attribute allows exact dates to be supplied if necessary, including the cases where a conference spreads over a range of dates or the date can only be supplied as a text string
ConferenceDate
b054
0…1
dateformat
<b054 dateformat="12">7–9 October 2009</b054>
P.8.7 Conference place

The place of a conference to which the product is related. Optional and non-repeating.

Variable length text, suggested maximum length 100 characters
ConferencePlace
b055
0…1
language
<ConferencePlace>Aix-les-Bains, France</ConferencePlace>
Conference sponsor composite

An optional and repeatable group of data elements which together identify a sponsor of a conference. Either an identifier, or one or other of <PersonName> or <CorporateName>, or both an identifier and a name, must be present in each occurrence of the composite.

ConferenceSponsor
conferencesponsor
0…n
Conference sponsor identifier composite

An optional and repeatable group of data elements which together carry a coded identifier for a sponsor of a conference.

ConferenceSponsorIdentifier
conferencesponsoridentifier
0…n
P.8.8 Conference sponsor identifier type

An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <ConferenceSponsorIdentifier> composite, and non-repeating.

Fixed length, two digits
List 44
ConferenceSponsorIDType
b391
1
<b391>01</b391> (Proprietary)
P.8.9 Identifier type name

A name which identifies a proprietary identifier scheme when, and only when, the code in the <ConferenceSponsorIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
 
P.8.10 Identifier value

A code value taken from the scheme specified in the <ConferenceSponsorIDType> element. Mandatory in each occurrence of the composite, and non-repeating.

Determined by the scheme specified in <ConferenceSponsorIDType>
IDValue
b244
1
 
End of Conference sponsor identifier composite
P.8.11 Person name

The name of a person, used here for a personal sponsor of a conference. Optional and non-repeating. Only one of <PersonName> and <CorporateName> can be sent in each occurrence of the <ConferenceSponsor> composite.

Variable length text, suggested maximum length 100 characters
PersonName
b036
0…1
collationkey, language, textscript
<PersonName>James J. Johnson III</PersonName>
P.8.12 Corporate name

The name of a corporate body, used here for a corporate sponsor of a conference. Optional and non-repeating. Only one of <PersonName> and <CorporateName> can be sent in each occurrence of the <ConferenceSponsor> composite.

Variable length text, suggested maximum length 200 characters
CorporateName
b047
0…1
collationkey, language, textscript
<b047>Johnson &amp; Johnson</b047> (note ‘&’ is a reserved character in XML)
End of Conference sponsor composite
Website composite

An optional group of data elements which together identify and provide a pointer to a website which is related to the conference identified in an occurrence of the <Conference> composite. Repeatable in order to provide links to multiple websites.

Website
website
0…n
P.8.13 Website purpose

An ONIX code which identifies the role or purpose of the website which is linked through the <WebsiteLink> element. Optional and non-repeating.

Fixed length, two digits
List 73
WebsiteRole
b367
0…1
<WebsiteRole>04</WebsiteRole> (Journal home page)
P.8.14 Website description

Free text describing the nature of the website which is linked through the <WebsiteLink> element. Optional, and repeatable to provide parallel descriptive text in multiple languages. The language attribute is optional for a single instance of <WebsiteDescription>, but must be included in each instance if <WebsiteDescription> is repeated.

Variable length text, suggested maximum length 300 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
WebsiteDescription
b294
0…n
language, textformat
 
End of Website composite
End of Conference composite
Event composite

A group of data elements which together describe an event to which the product is related. Optional, and repeatable if the product contains material from or is related to two or more events.

Event
event
0…n
P.8.16 Event role

An ONIX code which indicates the relationship between the product and an event to which it is related, eg Proceedings of conference / Selected papers from conference / Programme for sporting event / Guide for art exhibition. Mandatory and non-repeating.

Fixed length, two digits
List 20
EventRole
x515
1
<x515>03</x515> (Selected papers from conference)
P.8.17 Event name

The name of an event or series of events to which the product is related. This element is mandatory in each occurrence of the <Event> composite, and repeatable to provide parallel names for a single event in multiple languages (eg ‘United Nations Climate Change Conference’ and « Conférences des Nations unies sur les changements climatiques »). The language attribute is optional for a single instance of <EventName>, but must be included in each instance if <EventName> is repeated.

Variable length text, suggested maximum length 200 characters
EventName
x516
1…n
language
<x516 language="fre">Conférences des Nations unies sur les changements climatiques</x516> (United Nations Climate Change Conference)
P.8.18 Event acronym

An acronym used as a short form of the name of an event or series of events given in the <EventName> element. Optional, and repeatable to provide parallel acronyms for a single event in multiple languages. The language attribute is optional for a single instance of <EventAcronym>, but must be included in each instance if <EventAcronym> is repeated.

Variable length text, suggested maximum length 20 characters
EventAcronym
x517
0…n
language
<EventAcronym>UNFCCC COP21</EventAcronym>
P.8.19 Event number

The number of an event to which the product is related, within a series of events. Optional and non-repeating.

Positive integer, suggested maximum length 4 digits
EventNumber
x518
0…1
<x518>21</x518>
P.8.20 Event thematic title

The thematic title of an individual event in a series that has an event series name in the <EventName> element. Optional, and repeatable to provide parallel thematic titles for a single event in multiple languages. The language attribute is optional for a single instance of <EventTheme>, but must be included in each instance if <EventTheme> is repeated.

Variable length text, suggested maximum length 200 characters
EventTheme
x519
0…n
language
<EventTheme>Building a better world</EventTheme>
P.8.21 Event date

The date of an event to which the product is related. Optional and non-repeating.

As specified by the value in the dateformat attribute, or the default of YYYY if the attribute is missing. Note that the dateformat attribute allows exact dates to be supplied if necessary, including the cases where an event spreads over a range of dates or the date can only be supplied as a text string
EventDate
x520
0…1
dateformat
<EventDate dateformat="06">2015113020151215</EventDate> (30 November–15 December 2015)
P.8.22 Event place

The place of an event to which the product is related. Optional, and repeatable to provide parallel placenames for a single location in multiple languages. The language attribute is optional for a single instance of <EventPlace>, but must be included in each instance if <EventPlace> is repeated.

Variable length text, suggested maximum length 100 characters
EventPlace
x521
0…n
language
<EventPlace>Aix-les-Bains, France</EventPlace>
Event sponsor composite

An optional group of data elements which together identify an organizer or sponsor of an event. Either an identifier, or one or other of <PersonName> or <CorporateName>, or both an identifier and a name, must be present in each occurrence of the composite. The composite is repeatable in order to specify multiple organizers and sponsors.

EventSponsor
eventsponsor
0…n
Event sponsor identifier composite

An optional and repeatable group of data elements which together carry a coded identifier for an organizer or sponsor of an event.

EventSponsorIdentifier
eventsponsoridentifier
0…n
P.8.23 Event sponsor identifier type

An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <EventSponsorIdentifier> composite, and non-repeating.

Fixed length, two digits
List 44
EventSponsorIDType
x522
1
<x522>01</x522> (Proprietary)
P.8.24 Identifier type name

A name which identifies a proprietary identifier scheme when, and only when, the code in the <EventSponsorIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
 
P.8.25 Identifier value

A code value taken from the scheme specified in the <EventSponsorIDType> element. Mandatory in each occurrence of the composite, and non-repeating.

Determined by the scheme specified in <EventSponsorIDType>
IDValue
b244
1
 
End of Event sponsor identifier composite
P.8.26 Person name

The name of a person, used here for a personal organizer or sponsor of an event. Optional and non-repeating. Only one of <PersonName> or <CorporateName> can be sent in each occurrence of the <EventSponsor> composite.

Variable length text, suggested maximum length 100 characters
PersonName
b036
0…1
collationkey, language, textscript
<PersonName>James J. Johnson III</PersonName>
P.8.27 Corporate name

The name of a corporate body, used here for a corporate organizer or sponsor of an event. Optional and non-repeating. Only one of <PersonName> or <CorporateName> can be sent in each occurrence of the <EventSponsor> composite.

Variable length text, suggested maximum length 200 characters
CorporateName
b047
0…1
collationkey, language, textscript
<b047>Johnson &amp; Johnson</b047> (note ‘&’ is a reserved character in XML)
End of Event sponsor composite
Website composite

An optional group of data elements which together identify and provide a pointer to a website which is related to the event identified in an occurrence of the <Event> composite. Repeatable in order to provide links to multiple websites.

Website
website
0…n
P.8.28 Website purpose

An ONIX code which identifies the role or purpose of the website which is linked through the <WebsiteLink> element. Optional and non-repeating.

Fixed length, two digits
List 73
WebsiteRole
b367
0…1
<WebsiteRole>04</WebsiteRole> (Journal home page)
P.8.29 Website description

Free text describing the nature of the website which is linked through the <WebsiteLink> element. Optional, and repeatable to provide parallel descriptive text in multiple languages. The language attribute is optional for a single instance of <WebsiteDescription>, but must be included in each instance if <WebsiteDescription> is repeated.

Variable length text, suggested maximum length 300 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
WebsiteDescription
b294
0…n
language, textformat
 
End of Website composite
End of Event composite

P.9 Edition

Data element Group P.9 describes an edition of a work which is manifested in the product. Its use should generally be limited to describing an edition whose content is materially different from that of other editions of the same work. However, it may sometimes be used to specify a product feature (eg ‘bilingual edition’) without necessarily implying that another, different, edition also exists.

P.9.1 Edition type code

An ONIX code, indicating the type of a version or edition. Optional, and repeatable if the product has characteristics of two or more types (eg ‘revised’ and ‘annotated’).

Fixed length, three upper-case letters
List 21
EditionType
x419
0…n
<EditionType>ILL</EditionType> (Illustrated edition)
P.9.2 Edition number

The number of a numbered edition. Optional and non-repeating. Normally sent only for the second and subsequent editions of a work, but by agreement between parties to an ONIX exchange a first edition may be explicitly numbered.

Positive integer, suggested maximum length 4 digits
EditionNumber
b057
0…1
<b057>3</b057> (Third edition)
P.9.3 Edition version number

The number of a numbered revision within an edition number. To be used only where a publisher uses such two-level numbering to indicate revisions which do not constitute a new edition under a new ISBN or other distinctive product identifier. Optional and non-repeating. If this field is used, an <EditionNumber> must also be present.

Variable length text, suggested maximum length 20 characters
EditionVersionNumber
b217
0…1
<b217>2</b217> (Second revised impression of this edition)
P.9.4 Edition statement

A short free-text description of a version or edition. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <EditionStatement>, but must be included in each instance if <EditionStatement> is repeated. When used, an <EditionStatement> must be complete in itself, ie it should not be treated as merely supplementary to an <EditionType> or an <EditionNumber>, nor as a replacement for them. Appropriate edition type and number must also be sent, for indexing and retrieval. An <EditionStatement> should be strictly limited to describing features of the content of the edition, and should not include aspects such as rights or market restrictions which are properly covered elsewhere in the ONIX record.

Variable length text, suggested maximum length 200 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
EditionStatement
b058
0…n
language, textformat
<b058>3rd edition, revised with an introduction and notes</b058>
P.9.5 “No edition” indicator

An empty element that provides a positive indication that a product does not carry any edition information. Intended to be used an ONIX accreditation scheme to confirm that edition information is being consistently supplied in publisher ONIX feeds. Optional and non-repeating. Must only be sent in a record that has no instances of any of the four preceding Edition elements.

XML empty element
NoEdition/
n386/
0…1
<NoEdition/>
Religious text composite

An optional, non-repeating, group of data elements which together describe features of the content of an edition of a religious text, and intended to meet the special needs of religious publishers and booksellers. The <ReligiousText> composite may carry either a <Bible> composite or a <ReligiousTextIdentifier> element accompanied by multiple repeats of the <ReligiousTextFeature> composite. This approach is adopted to enable other devotional texts to be included if need arises without requiring a new ONIX release.

ReligiousText
religioustext
0…1
Bible composite

A group of data elements which together describe features of an edition of the Bible or of a selected Biblical text. Mandatory in each occurrence of the <ReligiousText> composite that does not include a <ReligiousTextIdentifier> element, and non-repeating.

Bible
bible
0…1
P.9.6 Bible contents

An ONIX code indicating the content of an edition of the Bible or selected Biblical text, for example ‘New Testament’, ‘Apocrypha’, ‘Pentateuch’. Mandatory in each occurrence of the <Bible> composite, and repeatable so that a list such as ‘Old Testament and Apocrypha’ can be expressed.

Fixed length, two letters
List 82
BibleContents
b352
1…n
<b352>OT</b352> (Old Testament)
P.9.7 Bible version

An ONIX code indicating the version of a Bible or selected Biblical text, for example ‘King James’, ‘Jerusalem’, ‘New American Standard’, ‘Reina Valera’. Mandatory in each occurrence of the <Bible> composite, and repeatable if a work includes text in two or more versions.

Fixed length, three letters
List 83
BibleVersion
b353
1…n
<BibleVersion>JER</BibleVersion> (Jerusalem)
P.9.8 Study Bible type

An ONIX code identifying a particular study version of a Bible or selected Biblical text, for example ‘Life Application’. Optional and non-repeating. Some study Bibles are available in different editions based on different text versions.

Fixed length, three letters
List 84
StudyBibleType
b389
0…1
<b389>OXF</b389> (Oxford Annotated)
P.9.9 Bible purpose

An ONIX code indicating the purpose for which a Bible or selected Biblical text is intended, for example ‘Family’, ‘Lectern/pulpit’. Optional, and repeatable to list multiple purposes.

Fixed length, two letters
List 85
BiblePurpose
b354
0…n
<BiblePurpose>LP</BiblePurpose> (Lectern/pulpit)
P.9.10 Bible text organization

An ONIX code indicating the way in which the content of a Bible or selected Biblical text is organized, for example ‘Chronological’, ‘Chain reference’. Optional and non-repeating.

Fixed length, three letters
List 86
BibleTextOrganization
b355
0…1
<b355>CHA</b355> (Chain reference)
P.9.11 Bible reference location

An ONIX code indicating where references are located as part of the content of a Bible or selected Biblical text, for example ‘Center column’. Optional and non-repeating.

Fixed length, three letters
List 87
BibleReferenceLocation
b356
0…1
<b356>CCL</b356> (Center column)
P.9.12 Bible text feature

An ONIX code specifying a feature of a Bible text not covered elsewhere, eg red letter. Optional, and repeatable to specify multiple features.

Fixed length, two letters
List 97
BibleTextFeature
b357
0…n
<BibleTextFeature>RL</BibleTextFeature> (Red letter)
End of Bible composite
P.9.13 Religious text identifier

An ONIX code indicating a religious text other than the Bible. Mandatory in each occurrence of the <ReligiousText> composite that does not include a <Bible> composite, and non-repeating.

Fixed length, two digits
List 88
ReligiousTextIdentifier
b376
0…1
 
Religious text feature composite

A repeatable group of data elements which together specify and describe a feature of a religious text. Mandatory if and only if <ReligiousTextIdentifier> is present.

ReligiousTextFeature
religioustextfeature
0…n
P.9.14 Religious text feature type

An ONIX code specifying a feature described in the associated <ReligiousTextFeatureCode> element. Mandatory in each occurrence of the <ReligiousTextFeature> composite, and non-repeating.

Fixed length, two digits
List 89
ReligiousTextFeatureType
b358
1
<b358>01</b358> (Church season or activity)
P.9.15 Religious text feature code

An ONIX code describing a feature specified in the associated <ReligiousTextFeatureType> element. Mandatory in each occurrence of the <ReligiousTextFeature> composite, and non-repeating.

Fixed length, two digits
List 90
ReligiousTextFeatureCode
b359
1
<ReligiousTextFeatureCode>10</ReligiousTextFeatureCode> (Lent)
P.9.16 Religious text feature description

Free text describing a feature that is not adequately defined by code values alone. Optional, and repeatable if parallel descriptive text is provided in multiple languages. The language attribute is optional for a single instance of <ReligiousTextFeatureDescription>, but must be included in each instance if <ReligiousTextFeatureDescription> is repeated.

Variable length text, suggested maximum 100 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
ReligiousTextFeatureDescription
b360
0…n
language, textformat
 
End of Religious text feature composite
End of Religious text composite

P.10 Language

These elements specify the language(s) of the text of a product and/or of an original work of which it is a translation. Group P.10 is not mandatory. A default language of text can be declared in an ONIX message header – see Header field H.17. Where applicable, the script in which the language is represented can also be specified.

Language composite

A group of data elements which together represent a language, and specify its role and, where required, whether it is a country variant. Optional, and repeatable to specify multiple languages and their various roles.

Language
language
0…n
P.10.1 Language role

An ONIX code indicating the ‘role’ of a language in the context of the ONIX record. Mandatory in each occurrence of the <Language> composite, and non-repeating.

Fixed length, two digits
List 22
LanguageRole
b253
1
<LanguageRole>01</LanguageRole> (Language of text)
P.10.2 Language code

An ISO code indicating a language. Mandatory in each occurrence of the <Language> composite, and non-repeating.

Fixed length, three lower-case letters. Note that ISO 639 specifies that these codes should always be in lower-case
ISO 639-2/B List 74
LanguageCode
b252
1
<b252>eng</b252> (English)
P.10.3 Country code

A code identifying the country when this specifies a variant of the language, eg US English. Optional and non-repeating.

Fixed length, two letters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes List 91
CountryCode
b251
0…1
<CountryCode>US</CountryCode> (US [English])
P.10.3a Region code

An ONIX code identifying the region when this specifies a variant of the language eg Flemish – Dutch as used in the Flemish region of Belgium. Optional and non-repeatable. A region is an area which is not a country (in the sense that it does not have a distinct country code), but which is precisely defined in geographical terms, eg Quebec, Scotland. If both country and region are specified, the region must be within the country. Note that US States have region codes, while US overseas territories have distinct ISO Country Codes.

Variable length code, consisting of upper case letters, with or without a hyphen and further upper case letters or digits. Suggested maximum length 8 characters
List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166-2
RegionCode
b398
0…1
<RegionCode>BE-VLG</RegionCode> (Flemish region)
P.10.4 Script code

A code identifying the script in which the language is represented. Optional and non-repeating.

Fixed length, four letters. Note that ISO 15924 specifies that script codes shall be sent as one upper case followed by three lower case letters
ISO 15924 four-letter script codes List 121
ScriptCode
x420
0…1
<ScriptCode>Cyrl</ScriptCode> (Cyrillic)
End of Language composite
product is in French, translated from original work in Old Norse
using Reference names
<Language>
    <LanguageRole>01</LanguageRole>
    <LanguageCode>fre</LanguageCode>
</Language>
<Language>
    <LanguageRole>02</LanguageRole>
    <LanguageCode>non</LanguageCode>
</Language>
using Short tags
<language>
    <b253>01</b253>Language of text
    <b252>fre</b252>
</language>
<language>
    <b253>02</b253>Language of original
    <b252>non</b252>
</language>

P.11 Extents and other content

Group P.11 covers product extents, in terms of pages, running times, file sizes etc, as may be appropriate to each media type. For products whose content is primarily readable text, it also covers illustrations and other kinds of ancillary matter such as the inclusion of a bibliography or index.

Extent composite

A group of data elements which together describe an extent pertaining to the product. Optional, but in practice required for most products, eg to give the number of pages in a printed book or paginated e-book, or to give the running time of an audiobook. Repeatable to specify different extent types or units.

Extent
extent
0…n
P.11.1 Extent type code

An ONIX code which identifies the type of extent carried in the composite, eg running time for an audio or video product. Mandatory in each occurrence of the <Extent> composite, and non-repeating. From Issue 9 of the code lists, an extended set of values for <ExtentType> has been defined to allow more accurate description of pagination.

Fixed length, two digits
List 23
ExtentType
b218
1
<ExtentType>09</ExtentType> (Duration [running time])
P.11.2 Extent value

The numeric value of the extent specified in <ExtentType>. Optional, and non-repeating. However, either <ExtentValue> or <ExtentValueRoman>, or both, must be present in each occurrence of the <Extent> composite; and it is very strongly recommended that <ExtentValue> should always be included, even when the original product uses Roman numerals.

Positive real number, with explicit decimal point when required, as appropriate for the units specified in <ExtentUnit>. Suggested maximum length 8 characters
ExtentValue
b219
0…1
<b219>2.5</b219>
P.11.3 Extent value in Roman numerals

The value of the extent expressed in Roman numerals. Optional, and non-repeating. Used only for page runs which are numbered in Roman.

Letters forming a valid Roman numeral
ExtentValueRoman
x421
0…1
<ExtentValueRoman>xxiii</ExtentValueRoman> (23)
P.11.4 Extent unit

An ONIX code indicating the unit used for the <ExtentValue> and the format in which the value is presented. Mandatory in each occurrence of the <Extent> composite, and non-repeating.

Fixed length, two digits
List 24
ExtentUnit
b220
1
<b220>04</b220> (Hours as integer and decimals)
End of Extent composite
use of Main content page count
using Reference names
<Extent>
    <ExtentType>00</ExtentType>Main content pages
    <ExtentValue>260</ExtentValue>
    <ExtentUnit>03</ExtentUnit>Pages
</Extent>
using Short tags
<extent>
    <b218>00</b218>
    <b219>260</b219>
    <b220>03</b220>
</extent>
Front matter and Main content page count
using Reference names
<Extent>
    <ExtentType>03</ExtentType>Front matter pages
    <ExtentValue>23</ExtentValue>In Arabic numerals
    <ExtentValueRoman>xxiii</ExtentValueRoman>In Roman numerals
    <ExtentUnit>03</ExtentUnit>Pages
</Extent>
<Extent>
    <ExtentType>00</ExtentType>Main content pages
    <ExtentValue>260</ExtentValue>
    <ExtentUnit>03</ExtentUnit>Pages
</Extent>
using Short tags
<extent>
    <b218>03</b218>
    <b219>23</b219>
    <x421>xxiii</x421>
    <b220>03</b220>
</extent>
<extent>
    <b218>00</b218>
    <b219>260</b219>
    <b220>03</b220>
</extent>
Running time eg of an audiobook
using Reference names, time in hours and minutes
<Extent>
    <ExtentType>09</ExtentType>Duration
    <ExtentValue>00305</ExtentValue>3hrs 5mins
    <ExtentUnit>15</ExtentUnit>Time in HHHMM
</Extent>
using Short tags, time in minutes
<extent>
    <b218>09</b218>
    <b219>185</b219>185 mins
    <b220>05</b220>Time in mins
</extent>
P.11.5 Illustrated yes/no

An ONIX code indicating whether a book or other textual (usually printed) product has illustrations. The more informative free text field <IllustrationsNote> and/or the <AncillaryContent> composite are strongly preferred. This element has been added specifically to cater for a situation where a sender of product information maintains only a yes/no flag, and it should not otherwise be used. Optional and non-repeating.

Fixed length, two digits
List 152
Illustrated
x422
0…1
<Illustrated>01</Illustrated> (No)
P.11.6 Number of illustrations

The total number of illustrations in a book or other printed product. The more informative free text field <IllustrationsNote> and/or the <AncillaryContent> composite are strongly preferred, but where a sender of product information maintains only a simple numeric field, the <NumberOfIllustrations> element may be used. Optional and non-repeating.

Positive integer or zero, suggested maximum length 6 digits
NumberOfIllustrations
b125
0…1
<NumberOfIllustrations>64</NumberOfIllustrations>
P.11.7 Illustrations and other contents note

For books or other text media only, this data element carries text stating the number and type of illustrations. The text may also include other content items, eg maps, bibliography, tables, index etc. Optional, and repeatable if parallel notes are provided in multiple languages. The language attribute is optional for a single instance of <IllustrationsNote>, but must be included in each instance if <IllustrationsNote> is repeated.

Variable length text, suggested maximum length 200 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
IllustrationsNote
b062
0…n
language, textformat
<b062>500 illustrations, 210 in full color</b062>
Ancillary content composite

A group of data elements which together specify the number of illustrations or other content items of a stated type which the product carries. Use of the <AncillaryContent> composite is optional, but is repeatable if necessary to specify different types of content items.

AncillaryContent
ancillarycontent
0…n
P.11.8 Illustration or other content type code

An ONIX code which identifies the type of illustration or other content to which an occurrence of the composite refers. Mandatory in each occurrence of the <AncillaryContent> composite, and non-repeating.

Fixed length, two digits
List 25
AncillaryContentType
x423
1
<x423>09</x423> (Illustrations, unspecified)
P.11.9 Illustration or other content type description

Text describing the type of illustration or other content to which an occurrence of the composite refers, when a code is insufficient. Optional, and repeatable if parallel descriptive text is provided in multiple languages. Required when <AncillaryContentType> carries the value 00. The language attribute is optional for a single instance of <AncillaryContentDescription>, but must be included in each instance if <AncillaryContentDescription> is repeated.

Variable length text, suggested maximum length 100 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
AncillaryContentDescription
x424
0…n
language, textformat
<x424 language="eng">Full color stickers</x424>
P.11.10 Number of illustrations or other content items

The number of illustrations or other content items of the type specified in <AncillaryContentType>. Optional and non-repeating.

Positive integer or zero, suggested maximum length 6 digits
Number
b257
0…1
<Number>12</Number>
End of Ancillary content composite
insert (plate section) with 51 color plates, plus index
using Reference names
<AncillaryContent>
    <AncillaryContentType>24</AncillaryContentType>
    <Number>51</Number>
</AncillaryContent>
<AncillaryContent>
    <AncillaryContentType>25</AncillaryContentType>
</AncillaryContent>
using Short tags
<ancillarycontent>
    <x423>24</x423>Color plates
    <b257>51</b257>
</ancillarycontent>
<ancillarycontent>
    <x423>25</x423>Index
</ancillarycontent>

P.12 Subject

Group P.12 has been simplified in ONIX 3.0 so that all subject codes and/or headings are sent using a single <Subject> composite, with a new <MainSubject/> flag to indicate what the sender regards as the main subject of the product.

While the XML Schema or DTD will allow an ONIX record to be sent without subject elements, it is expected that all ONIX descriptions should carry at least a main subject. US users are reminded that most US retailers and wholesalers require a BISAC subject category in order to load a record into their files; and for UK users a BIC subject category is mandatory in order to meet BIC Basic standards.

Subject composite

An optional and repeatable group of data elements which together specify a subject classification or subject heading.

Subject
subject
0…n
P.12.1 Main subject flag

An empty element that identifies an instance of the <Subject> composite as representing the main subject category for the product. The main category may be expressed in more than one subject scheme, ie there may be two or more instances of the <Subject> composite, using different schemes, each carrying the <MainSubject/> flag, so long as there is only one main category per scheme. Optional and non-repeating in each occurrence of the <Subject> composite.

XML empty element
MainSubject/
x425/
0…1
<MainSubject/>
P.12.2 Subject scheme identifier

An ONIX code which identifies the category scheme which is used in an occurrence of the <Subject> composite. Mandatory in each occurrence of the composite, and non-repeating.

For category schemes that use code values, use the associated <SubjectCode> element to carry the value (if so required, the <SubjectHeadingText> element can be used simultaneously to carry the text equivalent of the code). For schemes that use text headings, use the <SubjectHeadingText> element to carry the text of the category heading.

Fixed length, two alphanumeric characters
List 27
SubjectSchemeIdentifier
b067
1
<b067>03</b067> (US Library of Congress classification)
P.12.3 Proprietary subject scheme name

A name identifying a proprietary subject scheme (ie a scheme which is not a standard and for which there is no individual identifier code) when <SubjectSchemeIdentifier> is coded ‘24’. Optional and non-repeating.

Variable length text, suggested maximum length 100 characters
SubjectSchemeName
b171
0…1
language
<b121>RetailCo ShelfScheme</b121>
P.12.4 Subject scheme version number

A number which identifies a version or edition of the subject scheme specified in the associated <SubjectSchemeIdentifier> element. Optional and non-repeating.

Variable length alphanumeric, suggested maximum length 10 characters for consistency with other version number elements
SubjectSchemeVersion
b068
0…1
<SubjectSchemeVersion>2.1</SubjectSchemeVersion>
P.12.5 Subject code

A single subject class or category code from the scheme specified in the <SubjectSchemeIdentifier> element. Either <SubjectCode> or <SubjectHeadingText> or both must be present in each occurrence of the <Subject> composite. Non-repeating.

Variable length alphanumeric, suggested maximum length 20 characters
The scheme specified in the associated <SubjectSchemeIdentifier> element
SubjectCode
b069
0…1
<SubjectCode>623.95</SubjectCode>
P.12.6 Subject heading text

The text of a subject heading taken from the scheme specified in the <SubjectSchemeIdentifier> element, or of free language keywords if the scheme is specified as ‘keywords’; or the text equivalent to the <SubjectCode> value, if both code and text are sent. Either <SubjectCode> or <SubjectHeadingText> or both must be present in each occurrence of the <Subject> composite.

Optional, and repeatable if the text is sent in multiple languages. The language attribute is optional for a single instance of <SubjectHeadingText>, but must be included in each instance if <SubjectHeadingText> is repeated.

Variable length text, suggested maximum length 500 characters
SubjectHeadingText
b070
0…n
language
<b070>Labor and industrial relations</b070>
End of Subject composite
delivering both BISAC and BIC subject codes plus keywords
using Reference names
<Subject>
    <MainSubject/>
    <SubjectSchemeIdentifier>10</SubjectSchemeIdentifier>
    <SubjectSchemeVersion>2016</SubjectSchemeVersion>
    <SubjectCode>GAR006000</SubjectCode>
</Subject>
<Subject>
    <SubjectSchemeIdentifier>10</SubjectSchemeIdentifier>
    <SubjectSchemeVersion>20016</SubjectSchemeVersion>
    <SubjectCode>GAR028000</SubjectCode>
</Subject>
<Subject>
    <MainSubject/>
    <SubjectSchemeIdentifier>93</SubjectSchemeIdentifier>
    <SubjectSchemeVersion>1.2</SubjectSchemeVersion>
    <SubjectCode>WMD</SubjectCode>
</Subject>
<Subject>
    <SubjectSchemeIdentifier>20</SubjectSchemeIdentifier>
    <SubjectHeadingText>garden design; urban; patio; container gardening</SubjectHeadingText>
</Subject>
using Short tags
<subject>
    <x425/>Main subject code
    <b067>10</b067>BISAC scheme
    <b068>2016</b068>2016 version
    <b069>GAR006000</b069>
</subject>
<subject>
    <b067>10</b067>BISAC
    <b068>2016</b068>
    <b069>GAR028000</b069>secondary code
</subject>
<subject>
    <x425/>Main subject code
    <b067>93</b067>Thema scheme
    <b068>1.2</b068>Version 1.2
    <b069>WMD</b069>
</subject>
<subject>
    <b067>20</b067>Keywords
    <b070>garden design; urban; patio; container gardening</b070>
</subject>
Name as subject composite

An optional group of data elements which together represent the name of a person or organization – real or fictional – that is part of the subject of a product. Repeatable in order to name multiple persons or organizations.

Each instance of the composite must contain either:

  • one or more of the forms of representation of a person name, with or without an occurrence of the <NameIdentifier> composite; or
  • one or more of the forms of representation of a corporate name, with or without an occurrence of the <NameIdentifier> composite; or
  • an occurrence of the <NameIdentifier> composite without any accompanying name element(s).
NameAsSubject
nameassubject
0…n
P.12.7 to P.12.22: elements in the Name as subject composite

Elements P.12.7 to P.12.22 in the <NameAsSubject> composite are identical to P.7.5 to P.7.20 as specified in Group P.7.

Alternative name composite

A repeatable group of data elements which together represent an alternative name of a person or organization that is part of the subject of a product, and specify its type. The <AlternativeName> composite is optional.

AlternativeName
alternativename
0…n
P.12.23 to P.12.38: elements in the Alternative name composite

Elements P.12.23 to P.12.38 in the <AlternativeName> composite are identical to P.7.21 to P.7.36 as specified in Group P.7.

End of Alternative name composite
Subject date composite

A group of data elements which together specify a date associated with the person or organization identified in an occurrence of the <NameAsSubject> composite, eg birth or death. Optional, and repeatable to provide multiple dates with their various roles.

SubjectDate
subjectdate
0…n
P.12.39 Subject date role code

An ONIX code indicating the significance of the date in relation to the subject name. Mandatory in each occurrence of the <SubjectDate> composite, and non-repeating.

Fixed length, two digits
List 177
SubjectDateRole
x534
1
<x534>50</x534> (Date of birth)
P.12.40 Date format (deprecated)

An ONIX code indicating the format in which the date is given in <Date>. Optional and not repeatable. Deprecated – where possible, use the dateformat attribute instead.

Fixed length, two digits
List 55
DateFormat
j260
0…1
<j260>05</j260> (YYYY)
P.12.41 Date

The date specified in the <SubjectDateRole> field. Mandatory in each occurrence of the <SubjectDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then <DateFormat> indicates the format of the date; if both dateformat attribute and <DateFormat> element are missing, the default format is YYYYMMDD.

As specified by the value in the dateformat attribute, in <DateFormat>, or the default YYYYMMDD
Date
b306
1
dateformat
<b306 dateformat="05">1381</b306>
End of Subject date composite
Professional affiliation composite

An optional group of data elements which together identify a subject’s professional position and/or affiliation, repeatable to allow multiple positions and affiliations to be specified.

ProfessionalAffiliation
professionalaffiliation
0…n
P.12.42 to P.12.43: elements in the Professional affiliation composite

Elements P.12.42 and P.12.43 in the <ProfessionalAffiliation> composite are identical to P.7.40 and P.7.41 as specified in Group P.7.

End of Professional affiliation composite
End of Name as subject composite
using Reference names
<NameAsSubject>
    <NameType>00</NameType>
    <NameIdentifier>
        <NameIDType>16</NameIDType>
        <IDValue>000000010935660X</IDValue>
    </NameIdentifier>
    <PersonNameInverted>Thesiger, Wilfred</PersonNameInverted>
</NameAsSubject>
using Short tags
<nameassubject>
    <x414>00</x414>Type unspecified
    <nameidentifier>
        <x415>16</x415>ISNI
        <b244>000000010935660X</b244>
    </nameidentifier>
    <b037>Thesiger, Wilfred</b037>
</nameassubject>

P.13 Audience

Data element Group P.13 covers a range of methods of indicating the intended audience for a product. None is defined as mandatory in the XML Schema or DTD.

Note that UK educational levels are covered in the BIC educational purpose qualifier, part of the BIC Subject Categories scheme (see the <Subject> composite in Group P.12).

P.13.1 Audience code

An ONIX code, originally derived from BISAC and BIC lists, which identifies the broad audience or readership for which a product is intended. Optional, and repeatable if the product is intended for two or more groups. Deprecated, in favor of providing the same information within the <Audience> composite using code 01 from List 29.

Fixed length, two digits
List 28
AudienceCode
b073
0…n
<AudienceCode>04</AudienceCode> (Primary and secondary/elementary and high school)
Audience composite

An optional group of data elements which together describe an audience to which the product is directed. Repeatable to specify multiple distinct audiences.

Audience
audience
0…n
P.13.2 Audience code type

An ONIX code which identifies the scheme from which the code in <AudienceCodeValue> is taken. Mandatory in each occurrence of the <Audience> composite, and non-repeating.

Fixed length, two digits
List 29
AudienceCodeType
b204
1
<AudienceCodeType>02</AudienceCodeType> (Proprietary)
P.13.3 Audience code type name

A name which identifies a proprietary audience code when the code in <AudienceCodeType> indicates a proprietary scheme, eg a vendor’s own code. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
AudienceCodeTypeName
b205
0…1
language
 
P.13.4 Audience code value

A code value taken from the scheme specified in <AudienceCodeType>. Either <AudienceCodeValue> or <AudienceHeadingText> or both must be present in each occurrence of the <Audience> composite. Non-repeating.

Determined by the scheme specified in <AudienceCodeType>
AudienceCodeValue
b206
0…1
<AudienceCodeValue>06</AudienceCodeValue> (Professional and scholarly)
P.13.4a Audience heading text

The text of an audience heading taken from the scheme specified in the <AudienceCodeType> element; or the text equivalent to the <AudienceCodeValue> if both code and text are sent. Either <AudienceCodeValue> or <AudienceHeadingText> or both must be present in each occurrence of the <Audience> composite.

Optional, and repeatable if the text is sent in multiple languages. The language attribute is optional for a single instance of <AudienceHeadingText>, but must be included in each instance if <AudienceHeadingText> is repeated.

Variable length text, suggested maximum length 500 characters
AudienceHeadingText
x578
0…n
language
<x578 language="eng">Priority Parents</x578>
End of Audience composite
using Reference names
<Audience>
    <AudienceCodeType>01</AudienceCodeType>
    <AudienceCodeValue>03</AudienceCodeValue>
</Audience>
<Complexity>
    <ComplexitySchemeIdentifier>06</ComplexitySchemeIdentifier>
    <ComplexityCode>HL720L</ComplexityCode>
</Complexity>
using Short tags
<audience>
    <b204>01</b204>ONIX audience code
    <b206>03</b206>Young adult
</audience>
<complexity>
    <b077>06</b077>Lexile measure
    <b078>HL720L</b078>
</complexity>
Audience range composite

An optional group of data elements which together describe an audience or readership range for which a product is intended. The composite can carry a single value from, to, or exact, or a pair of values with an explicit from and to. Repeatable to specify the audience range with different qualifiers.

AudienceRange
audiencerange
0…n
P.13.5 Audience range qualifier

An ONIX code specifying the attribute (age, school grade etc) which is measured by the value in the <AudienceRangeValue> element. Mandatory in each occurrence of the <AudienceRange> composite, and non-repeating.

Fixed length, two digits
List 30
AudienceRangeQualifier
b074
1
<b074>11</b074> (US school grade)
P.13.6 Audience range precision (1)

An ONIX code specifying the ‘precision’ of the value in the <AudienceRangeValue> element which follows (from, to, exact). Mandatory in each occurrence of the <AudienceRange> composite, and non-repeating.

Fixed length, two digits
List 31
AudienceRangePrecision
b075
1
<b075>03</b075> (From)
P.13.7 Audience range value (1)

A value indicating an exact position within a range, or the upper or lower end of a range.

Variable length string, suggested maximum 10 characters, according to the scheme specified in <AudienceRangeQualifier>. (This element was originally defined as a variable-length integer, but its definition was extended in ONIX 2.1 to enable non-numeric values to be carried. For values that BISAC has defined for US school grades and pre-school levels, see List 77)
AudienceRangeValue
b076
1
<AudienceRangeValue>10</AudienceRangeValue>
P.13.8 Audience range precision (2)

An ONIX code specifying the ‘precision’ of the value in <AudienceRangeValue> element which follows. Optional and non-repeating. This second occurrence of the two elements <AudienceRangePrecision> and <AudienceRangeValue> is required only when a ‘from … to …’ range is specified.

Fixed length, two digits
List 31 The only value which is valid in this element is 04 (‘To’)
AudienceRangePrecision
b075
0…1
<AudienceRangePrecision>04</AudienceRangePrecision> (To)
P.13.9 Audience range value (2)

A value indicating the upper end of a range.

Variable length string, suggested maximum 10 characters, according to the scheme specified in <AudienceRangeQualifier>. (This element was originally defined as a variable-length integer, but its definition was extended in ONIX 2.1 to enable non-numeric values to be carried. For values that BISAC has defined for US school grades and pre-school levels, see List 77)
AudienceRangeValue
b076
0…1
<AudienceRangeValue>11</AudienceRangeValue>
End of Audience range composite
up to US school grade 4
using Reference names
<AudienceRange>
    <AudienceRangeQualifier>11</AudienceRangeQualifier>
    <AudienceRangePrecision>04</AudienceRangePrecision>
    <AudienceRangeValue>4</AudienceRangeValue>
</AudienceRange>
using Short tags
<audiencerange>
    <b074>11</b074>US school grade
    <b075>04</b075>Up to
    <b076>4</b076>Grade 4
</audiencerange>
from US school grade 9 up to grade 12
using Reference names
<AudienceRange>
    <AudienceRangeQualifier>11</AudienceRangeQualifier>
    <AudienceRangePrecision>03</AudienceRangePrecision>
    <AudienceRangeValue>9</AudienceRangeValue>
    <AudienceRangePrecision>04</AudienceRangePrecision>
    <AudienceRangeValue>12</AudienceRangeValue>
</AudienceRange>
using Short tags
<audiencerange>
    <b074>11</b074>US school grade
    <b075>03</b075>From
    <b076>9</b076>Grade 9
    <b075>04</b075>Up to
    <b076>12</b076>Grade 12
</audiencerange>
P.13.10 Audience description

Free text describing the audience for which a product is intended. Optional, and repeatable if parallel descriptive text is provided in multiple languages. The language attribute is optional for a single instance of <AudienceDescription>, but must be included in each instance if <AudienceDescription> is repeated.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
AudienceDescription
b207
0…n
language, textformat
 
Complexity composite

An optional group of data elements which together describe the level of complexity of a text. Repeatable to specify the complexity using different schemes.

Complexity
complexity
0…n
P.13.11 Complexity scheme identifier

An ONIX code specifying the scheme from which the value in <ComplexityCode> is taken. Mandatory in each occurrence of the <Complexity> composite, and non-repeating.

Fixed length, two digits
List 32
ComplexitySchemeIdentifier
b077
1
<b077>06</b077> (Lexile measure)
P.13.12 Complexity code

A code specifying the level of complexity of a text. Mandatory in each occurrence of the <Complexity> composite, and non-repeating.

Variable length alphanumeric, suggested maximum length 20 characters, according to the code type specified in the <ComplexitySchemeIdentifier> element
ComplexityCode
b078
1
<ComplexityCode>880L</ComplexityCode>
End of Complexity composite

End of Descriptive detail composite

Block 2: Marketing collateral detail

Collateral detail composite

The collateral detail block covers data Groups P.14 to P.17, all of which are primarily concerned with information and/or resources which in one way or another support the marketing of the product. The block as a whole is non-repeating.

The block is not mandatory within the <Product> record, nor are any of the individual sections mandatory within an occurrence of the block. However, in most circumstances, the block should contain at least one instance of <TextContent>, <CitedContent>, <SupportingResource> or <Prize>. It may be empty only within a partial or ‘block update’ (Notification or update type 04, see P.1.2), when the intention is to remove all previously-supplied collateral material.

CollateralDetail
collateraldetail
0…1

P.14 Descriptions and other supporting text

Group P.14 partly replaces the <OtherText> composite in Release 2.1. It is different, however, in that the new <TextContent> composite is strictly for text that is carried in the ONIX record. Text that is cited from a third-party source is now covered in Group P.15. Text that is offered for online access or download by the publisher or other sender of an ONIX record is covered in Group P.16.

Text content composite

An optional group of data elements which together carry text related to the product, repeatable in order to deliver multiple texts (often of different types, though for some text types there many be multiple instances of that type).

TextContent
textcontent
0…n
P.14.1 Text type code

An ONIX code which identifies the type of text which is sent in the <Text> element. Mandatory in each occurrence of the <TextContent> composite, and non-repeating.

Fixed length, two digits
List 153
TextType
x426
1
<TextType>04</TextType> (Table of contents)
P.14.2 Text audience

An ONIX code which identifies the audience for which the text in the <Text> element is intended. Mandatory in each occurrence of the <TextContent> composite, and repeatable.

Fixed length, two digits
List 154
ContentAudience
x427
1…n
<x427>03</x427> (End customers)
Territory composite

A group of data elements which together define a territory for which the text in the <Text> element is specifically intended. Optional in each occurrence of the <TextContent> composite, and non-repeating. If omitted, the text is intended for use wherever the product may be sold (see Group P.21). If included, the text should be used by recipients in the specified territory in preference to any text that lacks a specified territory.

Care should be taken to avoid ambiguities (for example two different ‘short descriptions’ – without language attributes or with the same language attribute – marked for use in the same country or region), and to ensure that appropriate descriptions and supporting text are supplied for all countries and regions where the product may be sold. The simplest way to accomplish the latter is to ensure at least one version of the text does not have a territory specified. Where multiple texts of the same type are provided, those without specific <Territory> composites are intended for use only where no appropriate targeted text is present.

Territory
territory
0…1
P.14.2a Countries included

One or more ISO standard codes identifying countries included in the territory. Successive codes must be separated by spaces. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

One or more fixed-length codes, each consisting of two upper case letters, and with successive codes being separated by spaces. Suggested maximum length 750 characters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes List 91
CountriesIncluded
x449
0…1
<CountriesIncluded>US CA</CountriesIncluded> (USA and Canada)
P.14.2b Regions included

One or more ONIX codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg World, Northern Ireland, Australian Capital Territory. Successive codes must be separated by spaces. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

One or more variable-length codes, each consisting of upper case letters, with or without a hyphen and further upper case letters or digits, and with successive codes being separated by spaces. Suggested maximum length 750 characters
List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166-2
RegionsIncluded
x450
0…1
<x450>GB-SCT GB-NIR GB-WLS</x450> (Includes Scotland, Northern Ireland, Wales)
P.14.2c Countries excluded

One or more ISO standard codes identifying countries excluded from the territory. Successive codes must be separated by spaces. Optional and non-repeating, and can only occur if the <RegionsIncluded> element is also present and includes a supra-national region code (such as ‘World’).

One or more fixed-length codes, each consisting of two upper case letters, and with successive codes being separated by spaces. Suggested maximum length 750 characters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes List 91
CountriesExcluded
x451
0…1
<CountriesExcluded>US CA</CountriesExcluded> (Excludes USA and Canada)
P.14.2d Regions excluded

One or more ONIX codes identifying regions excluded from the territory. Successive codes must be separated by spaces. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code (such as ‘World’).

One or more variable-length codes, each consisting of upper case letters, with or without a hyphen and further upper case letters or digits, and with successive codes being separated by spaces. Suggested maximum length 750 characters
List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166-2
RegionsExcluded
x452
0…1
<x452>CA-QC</x452> (Excludes Quebec)
End of Territory composite
P.14.3 Text

The text specified in the <TextType> element. Mandatory in each occurrence of the <TextContent> composite, and repeatable when essentially identical text is supplied in multiple languages. The language attribute is optional for a single instance of <Text>, but must be included in each instance if <Text> is repeated.

Variable length text. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
Text
d104
1…n
language, textformat
<Text textformat="05"><ul><li>Introduction: aesthetics and modernity; aesthetics and post-modernity</li><li>Part 1: Modern philosophy and the emergence of aesthetic theory – Kant: self-consciousness, knowledge and freedom; the unity of the subject; the unification of nature; the purpose of beauty; the limits of beauty</li><li>Part 2: German idealism and early German Romanticism: the ‘new mythology’; the romantic ‘new mythology’</li><li>Part 3: Reflections on the subject – Fichte, Holderlin and Novalis</li><li>Part 4: Schelling – art as the ‘organ of philosophy’: the development of consciousness; the structure of the ‘system of transcendental idealism’; the aesthetic absolute; mythology, art and language; mythology, language and being</li><li>Part 5…</li></ul></Text> (Table of contents supplied as a list, with XHTML markup)
<d104 language="eng">‘The Name of the Rose’ is the author’s first novel. It is a historical murder mystery set in an Italian monastery in the year 1327, and at the same time, it’s an intellectual puzzle weaving semiotics, biblical analysis, medieval studies and literary theory into gripping fiction.</d104>
<d104 language="ita">‘Il nome della rosa’ è il primo romanzo dell’autore. Si tratta di un misterioso omicidio storico ambientato in un monastero italiano nel corso dell’anno 1327, e allo stesso tempo, è un misterio intellettuale che unisce semiotica, analisi biblici, studi medievali e teoria letteraria nella narrativa avvincente.</d104> (Parallel short description text provided in two languages)
Review rating composite

An optional group of data elements which together specify a ‘star rating’ awarded as part of a review of the publication, used when <TextType> indicates the text is a review. Not repeatable.

ReviewRating
reviewrating
0…1
P.14.3a Review rating

The ‘star rating’ awarded as part of a review of the publication. Mandatory within an occurrence of the <ReviewRating> composite, and non-repeating.

Positive real number, with explicit decimal point when required, or zero, as appropriate for the limit specified in <RatingLimit>. Suggested maximum length 7 characters
Rating
x525
1
<Rating>4.5</Rating> (4.5 out of 5 stars)
P.14.3b Review rating limit

The maximum possible rating that may be awarded as part of a review of the publication. Optional, but where used, it must be greater than or equal to the specified <Rating>.

Positive integer number, suggested maximum length 4 digits
RatingLimit
x526
0…1
<RatingLimit>5</RatingLimit> (4.5 out of 5 stars)
P.14.3c Review rating units

The ‘units’ used by a rating, eg stars, tomatoes etc. Optional, and repeatable to provide the units in multiple languages. The language attribute is optional for a single instance of <RatingUnits>, but must be included in each instance if <RatingUnits> is repeated.

Variable length text, suggested maximum length 50 characters
RatingUnits
x527
0…n
language
<RatingUnits>stars</RatingUnits> (4.5 out of 5 stars)
End of Review rating composite
P.14.4 Author of text

The name of an author of text sent in the <Text> element, eg if it is a review or promotional quote. Optional, and repeatable if the text is jointly authored.

Variable length text, suggested maximum length 300 characters
TextAuthor
d107
0…n
language
<d107>Martin Amis</d107>
P.14.5 Corporate source of text

The name of a company or corporate body responsible for the text sent in the <Text> element. Optional and non-repeating.

Variable length text, suggested maximum length 200 characters
TextSourceCorporate
b374
0…1
language
<TextSourceCorporate>Random House Group</TextSourceCorporate>
P.14.5a Text source description

Brief text describing or providing context for the text author or corporate source, at the publisher’s discretion, and intended to be used in addition to <TextAuthor> or <TextSourceCorporate>. Optional, and repeatable to provide parallel descriptions in multiple languages. The language attribute is optional for a single instance of <TextSourceDescription>, but must be included in each instance if <TextSourceDescription> is repeated. The description may be used with either a person or corporate name, to draw attention to any aspect of the text source’s background which provides context for the text in <Text>.

Variable length text, suggested maximum length 200 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
TextSourceDescription
x557
0…n
language, textformat
<TextSourceDescription textformat="05">Literary editor of <cite>The Spectator</cite></ContributorDescription>
P.14.6 Source title

The title of a publication from which the text sent in the <Text> element was taken, eg if it is a review quote. Optional, and repeatable to provide the title in multiple languages. The language attribute is optional for a single instance of <SourceTitle>, but must be included in each instance if <SourceTitle> is repeated.

Variable length text, suggested maximum length 300 characters
SourceTitle
x428
0…n
language
<x428>New York Times</x428>
Content date composite

An optional group of data elements which together specify a date associated with the text carried in an occurrence of the <TextContent> composite, eg date when quoted text was published. Repeatable to specify different dates with their various roles.

ContentDate
contentdate
0…n
P.14.7 Content date role code

An ONIX code indicating the significance of the date in relation to the text content. Mandatory in each occurrence of the <ContentDate> composite, and non-repeating.

Fixed length, two digits
List 155
ContentDateRole
x429
1
<ContentDateRole>01</ContentDateRole> (Publication date)
P.14.8 Date format

An ONIX code indicating the format in which the date is given in <Date>. Optional in each occurrence of the <ContentDate> composite, and non-repeating. Deprecated – where possible, use the dateformat attribute on the <Date> element instead.

Fixed length, two digits
List 55
DateFormat
j260
0…1
<DateFormat>05</DateFormat> (YYYY)
P.14.9 Date

The date specified in the <ContentDateRole> field. Mandatory in each occurrence of the <ContentDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then <DateFormat> indicates the format of the date; if both dateformat attribute and <DateFormat> element are missing, the default format is YYYYMMDD.

As specified by the value in the dateformat attribute, in <DateFormat>, or the default YYYYMMDD
Date
b306
1
dateformat
<b306 dateformat="00">20010106</b306>
End of Content date composite
End of Text content composite

P.15 Cited content

Group P.15 describes cited material, with links to digital sources and/or references to conventional printed sources. In ONIX 3.0, cited content means content owned and/or published by a third party which is relevant to a product. The key distinction between supporting resources (P.16) and cited content is that a supporting resource comes with a clear invitation to the receiver to use it (subject to any specified limitations), while cited content is the intellectual property of a third party, subject to that party’s copyright or other rights, and can only be referenced.

Cited content composite

An optional group of data elements which together describe a piece of cited content. The composite is repeatable to describe and link to multiple items of cited material.

CitedContent
citedcontent
0…n
P.15.1 Cited content type code

An ONIX code indicating the type of content which is being cited. Mandatory in each occurrence of the <CitedContent> composite, and non-repeating.

Fixed length, two digits
List 156
CitedContentType
x430
1
<CitedContentType>01</CitedContentType> (Full text of review)
P.15.2 Target audience

An ONIX code which identifies the audience for which a piece of cited content is intended. Optional and repeatable.

Fixed length, two digits
List 154
ContentAudience
x427
0…n
<x427>04</x427> (Librarians)
Territory composite

A group of data elements which together define a territory for which the cited content is specifically intended. Optional in each occurrence of the <CitedContent> composite, and non-repeating. If omitted, the content is intended to be cited (linked to) wherever the product may be sold (see Group P.21). If included, the content should be cited by recipients in the specified territory in preference to any cited content that lacks a specified territory.

Care should be taken to avoid ambiguities (for example two different citations of the same type marked for use in the same country or region), and to ensure that appropriate citations are supplied for all countries and regions where the product may be sold. The simplest way to accomplish the latter is to ensure at least one version of the citation does not have a territory specified. Where multiple citations of the same type are provided, those without specific <Territory> composites are intended for use only where no appropriate targeted citation is present.

Territory
territory
0…1
P.15.2a to P.15.2d: elements in the Territory composite

Elements P.15.2a to P.15.2d in the <Territory> composite are identical to P.14.2a to P.14.2d as specified in Group P.14.

End of Territory composite
P.15.3 Source type

An ONIX code indicating the type of source from which the cited material originated, eg radio, TV. Optional, and non-repeating.

Fixed length, two digits
List 157
SourceType
x431
0…1
<SourceType>03</SourceType> (Radio)
Review rating composite

An optional group of data elements which together specify a ‘star rating’ awarded as part of a review of the publication, used where <CitedContentType> indicates the cited content is a review. Not repeatable.

ReviewRating
reviewrating
0…1
P.15.3a Review rating

An optional ‘star rating’ awarded as part of a review of the publication. Mandatory within an occurrence of the <ReviewRating> composite, and non-repeating.

Positive real number, with explicit decimal point when required, or zero, as appropriate for the limit specified in <RatingLimit>. Suggested maximum length 7 characters
Rating
x525
1
<Rating>4.5</Rating> (4.5 out of 5 stars)
P.15.3b Review rating limit

The maximum possible rating that may be awarded as part of a review of the publication. Optional, but where used, it must be greater than or equal to the specified <Rating>.

Positive integer number, suggested maximum length 4 digits
RatingLimit
x526
0…1
<RatingLimit>5</RatingLimit> (4.5 out of 5 stars)
P.15.3c Review rating units

The ‘units’ used by a rating, eg stars, tomatoes etc. Optional, and repeatable to provide the units in multiple languages. The language attribute is optional for a single instance of <RatingUnits>, but must be included in each instance if <RatingUnits> is repeated.

Variable length text, suggested maximum length 50 characters
RatingUnits
x527
0…n
language
<RatingUnits>stars</RatingUnits> (4.5 out of 5 stars)
End of Review rating composite
P.15.4 Source title

The title, name or short description of a publication, broadcast, website or other source of cited content. Optional, and repeatable; required unless the cited content refers to a bestseller list, and <ListName> is present. <SourceTitle> may be repeated to provide the title in multiple languages. The language attribute is optional for a single instance of <SourceTitle>, but must be included in each instance if <SourceTitle> is repeated.

Variable length text, suggested maximum length 300 characters
SourceTitle
x428
0…n
language
<SourceTitle>New York Times</SourceTitle>
P.15.5 Name of bestseller list

The name of a bestseller list, when the <CitedContent> composite is used to refer to a position which a product has reached on such a list. Optional, and repeatable to provide a parallel list name in multiple languages. The language attribute is optional for a single instance of <ListName>, but must be included in each instance if <ListName> is repeated.

Variable length text, suggested maximum length 100 characters
ListName
x432
0…n
language
<x432>Sunday Times Hardback Fiction</x432>
P.15.6 Position on list

The position that a product has reached on a bestseller list specified in <ListName>. Optional and non-repeating. The <ListName> element must also be present if <PositionOnList> is included.

Positive integer, suggested maximum length 3 digits
PositionOnList
x433
0…1
<PositionOnList>1</PositionOnList>
P.15.7 Citation note

A free text note giving any additional information about cited content, for example a detailed volume, issue and page reference to content cited from a periodical. Optional, and repeatable when parallel text is provided in multiple languages. The language attribute is optional for a single instance of <CitationNote>, but must be included in each instance if <CitationNote> is repeated.

Variable length text, suggested maximum length 300 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
CitationNote
x434
0…n
language, textformat
<CitationNote>Volume 3, page 7</CitationNote>
Content date composite

An optional and repeatable group of data elements which together specify a date associated with cited content, eg date on which it was published or broadcast.

ContentDate
contentdate
0…n
P.15.9 Content date role code

An ONIX code indicating the significance of the date in relation to the cited content. Mandatory in each occurrence of the <ContentDate> composite, and non-repeating.

Fixed length, two digits
List 155
ContentDateRole
x429
1
<ContentDateRole>01</ContentDateRole> (Publication date)
P.15.10 Date format

An ONIX code indicating the format in which the date is given in <Date>. Optional in each occurrence of the <ContentDate> composite, and non-repeating. Deprecated – where possible, use the dateformat attribute on the <Date> element instead.

Fixed length, two digits
List 55
DateFormat
j260
0…1
<DateFormat>05</DateFormat> (YYYY)
P.15.11 Date

The date specified in the <ContentDateRole> field. Mandatory in each occurrence of the <ContentDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then <DateFormat> indicates the format of the date; if both dateformat attribute and <DateFormat> element are missing, the default format is YYYYMMDD.

As specified by the value in the dateformat attribute, in <DateFormat>, or the default YYYYMMDD
Date
b306
1
dateformat
<b306 dateformat="00">20010106</b306>
End of Content date composite
End of Cited content composite
citing a review
using Reference names
<CitedContent>
    <CitedContentType>01</CitedContentType>
    <ContentAudience>00</ContentAudience>
    <SourceType>01</SourceType>
    <SourceTitle>The Guardian</SourceTitle>
    <CitationNote>Review of Jonathan Franzen’s ‘Freedom’ by Blake Morrison</CitationNote>
    <ResourceLink>http://www.​guardian.​co.​uk/​books/​2010/​sep/​18/​jonathan-​franzen-​freedom-​blake-​morrison</ResourceLink>
    <ContentDate>
        <ContentDateRole>01</ContentDateRole>
        <Date dateformat="00">20100918</Date>
    </ContentDate>
</CitedContent>
using Short tags
<citedcontent>
    <x430>01</x430>Review
    <x427>00</x427>Any audience
    <x431>01</x431>Printed media
    <x428>The Guardian</x428>
    <x434>Review of Jonathan Franzen’s ‘Freedom’ by Blake Morrison</x434>
    <x435>http://www.​guardian.​co.​uk/​books/​2010/​sep/​18/​jonathan-​franzen-​freedom-​blake-​morrison</x435>URL
    <contentdate>
        <x429>01</x429>Published
        <b306 dateformat="00">20100918</b306>
    </contentdate>
</citedcontent>

P.16 Links to supporting resources

Group P.16 describes supporting resources, with links to their web addresses. In ONIX 3.0, a supporting resource is a piece of content in digital form which is offered by a publisher or other supply chain participant to be used by the receiver of an ONIX feed for promotional purposes, or as additional information. The key distinction between supporting resources and cited content (P.15) is that a supporting resource comes with a clear invitation to the receiver to use it (subject to any specified limitations), while cited content is the intellectual property of a third party, subject to that party’s copyright or other rights, and can only be referenced.

Supporting resource composite

An optional group of data elements which together describe a supporting resource. The composite is repeatable to describe and link to multiple resources. Note that different forms of the same resource (for example a cover image in separate low and high resolution versions) should be specified in a single instance of the composite.

SupportingResource
supportingresource
0…n
P.16.1 Resource content type code

An ONIX code indicating the type of content carried in a supporting resource. Mandatory in each occurrence of the <SupportingResource> composite, and non-repeating.

Fixed length, two digits
List 158
ResourceContentType
x436
1
<ResourceContentType>01</ResourceContentType> (Front cover)
P.16.2 Target audience

An ONIX code which identifies the audience for which the supporting resource is intended. Mandatory in each occurrence of the <SupportingResource> composite, and repeatable.

Fixed length, two digits
List 154
ContentAudience
x427
1…n
<x427>00</x427> (Unrestricted [any audience])
Territory composite

A group of data elements which together define a territory for which the supporting resource is specifically intended. Optional in each occurrence of the <SupportingResource> composite, and non-repeating. If omitted, the supporting resource is intended for use wherever the product may be sold (see Group P.21). If included, the resource should be used by recipients in the specified territory in preference to any supporting resource that lacks a specified territory.

Care should be taken to avoid ambiguities (for example two different cover images marked for use in the same country or region), and to ensure that appropriate resources are supplied for all countries and regions where the product may be sold. The simplest way to accomplish the latter is to ensure at least one version of the resource does not have a territory specified. Where multiple resources of the same type are provided, those without specific <Territory> composites are intended for use only where no appropriate targeted resource is present.

Territory
territory
0…1
P.16.2a to P.16.2d: elements in the Territory composite

Elements P.16.2a to P.16.2d in the <Territory> composite are identical to P.14.2a to P.14.2d as specified in Group P.14.

End of Territory composite
P.16.3 Resource mode

An ONIX code indicating the mode of the supporting resource, eg audio, video. Mandatory in each occurrence of the <SupportingResource> composite, and non-repeating.

Fixed length, two digits
List 159
ResourceMode
x437
1
<ResourceMode>03</ResourceMode> (Still image)
Resource feature composite

A group of data elements which together describe a feature of a supporting resource which is common to all versions in which the resource is offered. Optional, and repeatable in order to describe multiple features of the resource.

ResourceFeature
resourcefeature
0…n
P.16.4 Resource feature type

An ONIX code which specifies the feature described by an instance of the <ResourceFeature> composite. Mandatory in each occurrence of the composite, and non-repeating.

Fixed length, two digits
List 160
ResourceFeatureType
x438
1
<x438>01</x438> (Required credit)
P.16.5 Resource feature value

A controlled value that describes a resource feature. Presence or absence of this element depends on the <ResourceFeatureType>, since some features may not require an accompanying value, while others may require free text in <FeatureNote>; and others may have both code and free text. Non-repeating.

Dependent on the scheme specified in <ResourceFeatureType>
Dependent on the scheme specified in <ResourceFeatureType>
FeatureValue
x439
0…1
<FeatureValue>4</FeatureValue>
P.16.6 Resource feature note

If the <ResourceFeatureType> requires free text rather than a code value, or if the code in <FeatureValue> does not adequately describe the feature, a short text note may be added. Optional, and repeatable when parallel notes are provided in multiple languages. The language attribute is optional for a single instance of <FeatureNote>, but must be included in each instance if <FeatureNote> is repeated.

Variable length text, suggested maximum length 300 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
FeatureNote
x440
0…n
language, textformat
<FeatureNote>Photo by Jerry Bauer</FeatureNote>
End of Resource feature composite
Resource version composite

A group of data elements which together describe a single version of a supporting resource, for example a particular format of a cover image. At least one instance is mandatory in each occurrence of the <SupportingResource> composite, and the composite should be repeated as necessary if the resource is offered in multiple versions.

ResourceVersion
resourceversion
1…n
P.16.7 Resource form

An ONIX code indicating the form of a version of a supporting resource. Mandatory in each occurrence of the <ResourceVersion> composite, and non-repeating.

Fixed length, two digits
List 161
ResourceForm
x441
1
<ResourceForm>02</ResourceForm> (Downloadable file)
Resource version feature composite

A group of data elements which together describe a feature of a supporting resource which is specific to a particular version in which the resource is offered. Formally optional, but it is unlikely that a supporting resource version could be adequately described without specifying some of its features. Repeatable in order to specify multiple features of the version of the resource.

ResourceVersionFeature
resourceversionfeature
0…n
P.16.8 Resource version feature type

An ONIX code which specifies a feature described by an instance of the <ResourceVersionFeature> composite. Mandatory in each occurrence of the composite, and non-repeating.

Fixed length, two digits
List 162
ResourceVersionFeatureType
x442
1
<x442>03</x442> (Image width in pixels)
P.16.9 Resource version feature value

A controlled value that describes a resource version feature. Presence or absence of this element depends on the <ResourceVersionFeatureType>, since some features may not require an accompanying value, while others may require free text in <FeatureNote>, and others may have both a value and free text. Non-repeating.

Dependent on the feature specified in <ResourceVersionFeatureType>; the feature value may or may not be taken from a code list
Dependent on the feature specified in <ResourceVersionFeatureType>
For file format, use List 178
FeatureValue
x439
0…1
<FeatureValue>250</FeatureValue>
P.16.10 Resource version feature note

If the <ResourceVersionFeatureType> requires free text rather than a code value, or if the code in <FeatureValue> does not adequately describe the feature, a short text note may be added. Optional, and repeatable when parallel notes are provided in multiple languages. The language attribute is optional for a single instance of <FeatureNote>, but must be included in each instance if <FeatureNote> is repeated.

Variable length text, suggested maximum length 300 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
FeatureNote
x440
0…n
language, textformat
 
End of Resource version feature composite
Content date composite

An optional group of data elements which together specify a date associated with a supporting resource version, eg the date until which the resource version will be available for download. Repeatable to specify different dates with their various roles.

ContentDate
contentdate
0…n
P.16.12 Content date role code

An ONIX code indicating the significance of the date in relation to the supporting resource. Mandatory in each occurrence of the <ContentDate> composite, and non-repeating.

Fixed length, two digits
List 155
ContentDateRole
x429
1
<x429>15</x429> ([Resource available] Until)
P.16.13 Date format

An ONIX code indicating the format in which the date is given in <Date>. Optional in each occurrence of the <ContentDate> composite, and non-repeating. Deprecated – where possible, use the dateformat attribute instead.

Fixed length, two digits
List 55
DateFormat
j260
0…1
<DateFormat>00</DateFormat> (YYYYMMDD)
P.16.14 Date

The date specified in the <ContentDateRole> field. Mandatory in each occurrence of the <ContentDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then <DateFormat> indicates the format of the date; if both dateformat attribute and <DateFormat> element are missing, the default format is YYYYMMDD.

As specified by the value in the dateformat attribute, in <DateFormat>, or the default YYYYMMDD
Date
b306
1
dateformat
<b306 dateformat="00">20100106</b306>
End of Content date composite
End of Resource version composite
End of Supporting resource composite
Front cover, available as either a large TIFF or a JPEG thumbnail
using Reference names
<SupportingResource>
    <ResourceContentType>01</ResourceContentType>
    <ContentAudience>00</ContentAudience>
    <ResourceMode>03</ResourceMode>
    <!-- ResourceFeatures go here -->
    <ResourceVersion>
        <ResourceForm>02</ResourceForm>
        <ResourceVersionFeature>
            <ResourceVersionFeatureType>01 </ResourceVersionFeatureType>
            <FeatureValue>D504</FeatureValue>
        </ResourceVersionFeature>
        <ResourceLink>http://www.publisher.com/covers/ 9780001234567.tif</ResourceLink>
        <ContentDate>
            <ContentDateRole>17</ContentDateRole>
            <Date dateformat="00">20100412</Date>
        </ContentDate>
    </ResourceVersion>
    <ResourceVersion>
        <ResourceForm>01</ResourceForm>
        <ResourceVersionFeature>
            <ResourceVersionFeatureType>01 </ResourceVersionFeatureType>
            <FeatureValue>D502</FeatureValue>
        </ResourceVersionFeature>
        <ResourceVersionFeature>
            <ResourceVersionFeatureType>02 </ResourceVersionFeatureType>
            <FeatureValue>171</FeatureValue>
        </ResourceVersionFeature>
        <ResourceVersionFeature>
            <ResourceVersionFeatureType>03 </ResourceVersionFeatureType>
            <FeatureValue>125</FeatureValue>
        </ResourceVersionFeature>
        <ResourceLink>http://www.publisher.com/covers/ 9780001234567.jpg</ResourceLink>
        <ContentDate>
            <ContentDateRole>17</ContentDateRole>
            <Date dateformat="00">20100412</Date>
        </ContentDate>
    </ResourceVersion>
</SupportingResource>
using Short tags
<supportingresource>A resource
    <x436>01</x436>Is front cover
    <x427>00</x427>For all audiences
    <x437>03</x437>Is an image
    <!-- resourcefeatures go here -->eg caption, credit
    <resourceversion>Resource version 1
        <x441>02</x441>Downloadable
        <resourceversionfeature>
            <x442>01</x442>File format
            <x439>D504</x439>TIFF
        </resourceversionfeature>
        <x435>http://www.publisher.com/covers/ 9780001234567.tif</x435>URL
        <contentdate>
            <x429>17</x429>Last updated
            <b306 dateformat="00">20100412</b306>
        </contentdate>
    </resourceversion>
    <resourceversion>Resource version 2
        <x441>01</x441>Linkable
        <resourceversionfeature>
            <x442>01</x442>File format
            <x439>D502</x439>JPEG
        </resourceversionfeature>
        <resourceversionfeature>
            <x442>02</x442>Image height
            <x439>171</x439>171 pixels
        </resourceversionfeature>
        <resourceversionfeature>
            <x442>03</x442>Image width
            <x439>125</x439>125 pixels
        </resourceversionfeature>
        <x435>http://www.publisher.com/covers/ 9780001234567.jpg</x435>URL
        <contentdate>
            <x429>17</x429>Last upated
            <b306 dateformat="00">20100412</b306>
        </contentdate>
    </resourceversion>
</supportingresource>

P.17 Prizes

Group P.17 covers details of any prizes or awards that have been won by a product or by a work which is manifested in the product.

Prize or award composite

An optional group of data elements which together describe a prize or award won by the product or work, and repeatable where it has gained multiple prizes or awards.

Prize
prize
0…n
P.17.1 Prize or award name

The name of a prize or award which the product or work has received. Mandatory in each occurrence of the <Prize> composite, and repeatable to provide a parallel award name in multiple languages. The language attribute is optional for a single instance of <PrizeName>, but must be included in each instance if <PrizeName> is repeated.

Variable length text, suggested maximum length 100 characters
PrizeName
g126
1…n
language
<PrizeName>Man Booker Prize</PrizeName>
P.17.2 Prize or award year

The year in which a prize or award was given. Optional and non-repeating.

Four digits, YYYY
PrizeYear
g127
0…1
<PrizeYear>1999</PrizeYear>
P.17.3 Prize or award country

An ISO standard code identifying the country in which a prize or award is given. Optional and non-repeating.

Fixed length, two letters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes List 91
PrizeCountry
g128
0…1
<g128>US</g128>
P.17.3a Prize or award region

An ONIX code identifying the region in which a prize or award is given. Optional and non-repeatable. A region is an area which is not a country, but which is precisely defined in geographical terms, eg Newfoundland and Labrador, Florida. If both country and region are specified, the region must be within the country. Note that US States have region codes, while US overseas territories have distinct ISO Country Codes.

Variable length code, consisting of upper case letters, with or without a hyphen and further upper case letters or digits. Suggested maximum length 8 characters
List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166-2
PrizeRegion
x556
0…1
<PrizeRegion>GB-WLS</PrizeRegion> (Wales)
P.17.4 Prize or award achievement code

An ONIX code indicating the achievement of the product in relation to a prize or award, eg winner, runner-up, shortlisted. Optional and non-repeating.

Fixed length, two digits
List 41
PrizeCode
g129
0…1
<PrizeCode>02</PrizeCode> (Runner up)
P.17.4a Prize statement

A short free-text description of the prize or award, intended primarily for display. Optional, and repeatable if the text is provided in more than one language. The language attribute is optional for a single instance of <PrizeStatement>, but must be included in each instance if <PrizeStatement> is repeated.

<PrizeStatement> is intended for display purposes only. When used, a <PrizeStatement> must be complete in itself, ie it should not be treated as merely supplementary to other elements within the <Prize> composite. Nor should <PrizeStatement> be supplied instead of those other elements – at minimum, the <PrizeCode> element, and whenever appropriate the <PrizeYear> element should be supplied.

Variable length text, suggested maximum length 500 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
PrizeStatement
x503
0…n
language, textformat
<PrizeStatement language="eng" textformat="05"><p>Joint winner of the <cite>Mao Dun Literature Prize</cite>, 2000</p></PrizeStatement>
P.17.5 Prize or award jury

Free text listing members of the jury that awarded the prize. Optional, and repeatable if the text is provided in more than one language. The language attribute is optional for a single instance of <PrizeJury>, but must be included in each instance if <PrizeJury> is repeated.

Variable length text, suggested maximum length 500 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
PrizeJury
g343
0…n
language, textformat
<g343>Russell Banks, Victoria Glendinning and Alistair MacLeod</g343>
End of Prize or award composite
multiple prizewinner
using Reference names
<Prize>
    <PrizeName>Giller Prize</PrizeName>
    <PrizeYear>1996</PrizeYear>
    <PrizeCountry>CA</PrizeCountry>
    <PrizeCode>01</PrizeCode>
    <PrizeJury>Bonnie Burnard, Carol Shields and David Staines</PrizeJury>
</Prize>
<Prize>
    <PrizeName>Booker Prize</PrizeName>
    <PrizeYear>1996</PrizeYear>
    <PrizeCountry>GB</PrizeCountry>
    <PrizeCode>04</PrizeCode>
    <PrizeStatement>Among the six novels shortlisted for the 1996 Booker Prize</PrizeStatement>
</Prize>
using Short tags
<prize>
    <g126>Giller Prize</g126>
    <g127>1996</g127>
    <g128>CA</g128>
    <g129>01</g129>Winner
    <g343>Bonnie Burnard, Carol Shields and David Staines</g343>
</prize>
<prize>
    <g126>Booker Prize</g126>
    <g127>1996</g127>
    <g128>GB</g128>
    <g129>04</g129>Shortlisted
    <x503>Among the six novels shortlisted for the 1996 Booker Prize</x503>
</prize>

End of Collateral detail composite

Block 7: Promotion detail

Promotion detail composite

The promotion detail block comprises the single data Group P.27. The block as a whole is optional and non-repeating, and is used only when there is a need to describe various promotional events intended to promote the product in a structured way. When used, the block usually consists of one or more instances of <PromotionalEvent>. It may be empty only within a partial or ‘block update’ (Notification or update type 04, see P.1.2), when the intention is to remove all previously-supplied promotion detail.

PromotionDetail
promotiondetail
0…1

P.27 Promotional events

Block 7 may contain one or more repeats of the <PromotionalEvent> composite, each describing a single event such as an author tour organised to promote the product or work. The event consists of one or more occurrences, for example a particular stop on a tour. Each occurrence shares key attributes such as the event type and the participants with other occurrences, while having unique attributes such as the date, time and location.

Promotional event composite

An group of data elements which together describe a promotional event or series of event occurrences such as an author tour. Optional in any occurrence of the <PromotionDetail> composite, but it may be omitted only within a partial or ‘block update’ (Notification or update type 04, see P.1.2) when the intention is to remove all previously supplied promotional event detail. When used normally, it is repeatable to describe multiple events linked to promotion of the product.

The promotional event composite must contain at least one <EventOccurrence>. It may optionally contain one or more contributors to the event, listing those that are also contributors to the product using <ContributorReference> and those that are not contributors to the product using <Contributor>. If there are no contributors to the event of either type, an optional <NoContributor/> flag may be included instead.

PromotionalEvent
promotionalevent
0…n
Event identifier composite

An optional group of data elements which together define an identifier for an event. The composite is repeatable in order to specify multiple identifiers for the same event.

EventIdentifier
eventidentifier
0…n
P.27.1 Event identifier type

An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Since there is no suitable standard event identifier scheme, the only valid option is to use a proprietary identifier. Mandatory in each occurrence of the <EventIdentifier> composite.

Fixed length, two digits
List 244
EventIDType
x547
1
<EventIDType>01</EventIDType> (Proprietary)
P.27.2 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <EventIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<b233>XYZ Publishers Event Number</b233>
P.27.3 Identifier value

A code value taken from the scheme specified in the <EventIDType> element. Mandatory in each occurrence of the <EventIdentifier> composite, and non-repeating.

Determined by the scheme specified in <EventIDType>
IDValue
b244
1
<b244>9887933e-314b-4295-862b-12acfebd1a60</b244>
End of Event identifier composite
P.27.4 Event type

A mandatory ONIX code which specifies the type of promotional event. Repeatable for promotional events which combine different event types.

Fixed length, two digits
List 245
EventType
x548
1…n
<x548>01</x548> (Book signing)
P.27.5 Event status

An ONIX code which specifies the status of a promotional event. Optional within each instance of the <PromotionalEvent> composite, and non-repeatable.

Fixed length, single character
List 246
EventStatus
x549
0…1
<EventStatus>A</EventStatus> (Announced)
P.27.6 Target audience

An ONIX code which identifies the audience for which a promotional event is intended. Mandatory within in each instance of the <PromotionalEvent> composite, and repeatable.

Fixed length, two digits
List 154
ContentAudience
x427
1…n
<ContentAudience>03</ContentAudience> (End customers)
P.27.7 Event name

The name of or headline for a promotional event or series of events which relate to the product. This element is mandatory within each instance of the <PromotionalEvent> composite, and repeatable to provide parallel names for a single event in multiple languages. The language attribute is optional for a single instance of <EventName>, but must be included in each instance if <EventName> is repeated.

Variable length text, suggested maximum length 200 characters
EventName
x516
1…n
language
<x516>Meet the Writer: Daniel Handler (aka Lemony Snicket)</x516>
Contributor by reference composite

Optional composite that identifies a contributor – a person or corporate body – participating in the promotional event who is also a contributor to the product, or who is its subject (ie who is fully described in an instance of the <Contributor> composite within Groups P.5, P.7 or P.18, or in an instance of <NameAsSubject> within Groups P.12 or P.18, in the same Product record). Repeatable to refer to multiple contributors.

Note that an instance of <PromotionalEvent> may also contain one or more <Contributor> composites – the latter listing participants to the event who are not contributors to the product.

ContributorReference
contributorreference
0…n
P.27.8 Event contributor sequence number

A number which specifies a single overall sequence of event participant names. Optional and non-repeating. It is strongly recommended that each occurrence of the <ContributorReference> and <Contributor> composites within <PromotionalEvent> should carry a <SequenceNumber>. The sequence is independent of the sequence of contributors to the product specified in Groups P.5, P.7 or P.18.

Positive integer, 1, 2, 3 etc, suggested maximum length 3 digits
SequenceNumber
b034
0…1
<SequenceNumber>3</SequenceNumber>
P.27.9 Event contributor role

An ONIX code indicating the role played by a person or corporate body participating in a promotional event, which need not be the same role as specified for the contributor referenced in Groups P.5, P.7 or P.18. Mandatory in each instance of the <ContributorReference> composite, and may be repeated if the same person or corporate body has more than one role in relation to the event.

Fixed length, one letter and two digits
List 17
ContributorRole
b035
1…n
<b035>E09</b035> (Speaker)
Name identifier composite

A group of data elements which together specify a name identifier, used here to carry an identifier for a personal or organizational name which must match a name identifier in an instance of the <Contributor> composite within Groups P.5, P.7 or P.18, or in an instance of <NameAsSubject> within Groups P.12 or P.18, in the same Product record. The <NameIdentifier> composite is mandatory within each instance of the <ContributorReference> composite, and is repeatable to specify name identifiers of different types for the same person or organization name.

NameIdentifier
nameidentifier
1…n
P.27.10 to P.27.12: elements in the Name identifier composite

Elements P.27.10 to P.27.12 in the <NameIdentifier> composite are identical to P.7.6 to P.7.8 as specified in Group P.7.

End of Name identifier composite
End of Contributor by reference composite
reference to author participating in a promotional event
using Reference names
<ContributorReference>
    <SequenceNumber>1</SequenceNumber>
    <ContributorRole>E09</ContributorRole>
    <NameIdentifier>
        <NameIDType>16</NameIDType>
        <IDValue>0000000121466844</IDValue>
    </NameIdentifier>
</ContributorReference>
using Short tags
<contributorreference>
    <b034>1</b034>
    <b035>E09</b035>Speaker
    <nameidentifier>
        <x415>16</x415>ISNI
        <b244>0000000121466844</b244>
    </nameidentifier>
</contributorreference>
Contributor composite

Optional composite that describes a contributor – a person or corporate body – participating in the promotional event who is neither a contributor to the product, nor its subject (ie is not described in an instance of the <Contributor> composite within Groups P.5, P.7 or P.18, or in an instance of <NameAsSubject> within Groups P.12 or P.18, in the same Product record). Repeatable to identify multiple contributors.

Contributor
contributor
0…n
P.27.13 to P.27.62a: elements in the Contributor composite

Elements P.27.13 to P.27.62a in the <Contributor> composite are identical to P.7.1 to P.7.50a as specified in Group P.7.

End of Contributor composite
P.27.63 Contributor statement

Free text showing how the participants at a promotional event should be described in an online display, when a standard concatenation of individual Contributor reference and Contributor elements would not give a satisfactory presentation. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <ContributorStatement>, but must be included in each instance if <ContributorStatement> is repeated. When the <ContributorStatement> field is sent, the receiver should use it to replace all name detail (though not the biographical, date or place details) sent in the <Contributor> composites for display purposes only for the promotional event. The individual name detail must also be sent in the <ContributorReference> and <Contributor> composites for indexing and retrieval.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
ContributorStatement
b049
0…n
language, textformat
 
P.27.64 “No contributor” indicator

An empty element that provides a positive indication that a promotional event has no named participants. Optional and non-repeating. Must only be sent in a <PromotionalEvent> composite that has neither <ContributorReference> nor <Contributor> composites.

XML empty element
NoContributor/
n339/
0…1
<n339/>
P.27.65 Event description

Free text describing the promotional event as a whole. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <EventDescription>, but must be included in each instance if <EventDescription> is repeated.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
EventDescription
x550
0…n
language, textformat
<EventDescription textformat="05"><p>Daniel Handler will be reading from his latest hardback <cite>Bottle Grove</cite>, and signing copies of this and his earlier novels.</p></EventDescription>
Event occurrence composite

A group of data elements which together describe a single occurrence of the promotional event. At least one occurence is mandatory within the <PromotionalEvent> composite, and <EventOccurrence> is repeatable in order to list a group of more or less similar occurrences such as a series of book signings.

EventOccurrence
eventoccurrence
1…n
Event occurrence identifier composite

An optional group of data elements which together define an identifier for an event occurrence. The composite is repeatable in order to specify multiple identifiers for the same occurrence.

EventIdentifier
eventidentifier
0…n
P.27.66 Event occurrence identifier type

An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Since there is no suitable standard event occurrence identifier scheme, the only valid option is to use a proprietary identifier. Mandatory in each occurrence of the <EventIdentifier> composite.

Fixed length, two digits
List 244
EventIDType
x547
1
<EventIDType>01</EventIDType> (Proprietary)
P.27.67 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <EventIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<b233>XYZ Publishers Event Number</b233>
P.27.68 Identifier value

A code value taken from the scheme specified in the <EventIDType> element. Mandatory in each occurrence of the <EventIdentifier> composite, and non-repeating.

Determined by the scheme specified in <EventIDType>
IDValue
b244
1
<b244>9887933e-314b-4295-862b-12acfebd1a60</b244>
End of Event occurrence identifier composite
Event occurrence date composite

A group of data elements which together specify a date associated with the event occurrence. At least the date (and typically also the time) the event occurrence begins must be specified, and other dates related to the event occurrence can be sent in further repeats of the composite.

OccurrenceDate
occurrencedate
1…n
P.27.69 Occurrence date role

An ONIX code indicating the significance of the date, eg the date of the occurrence, last date of ticket availability etc. Mandatory in each instance of the <OccurrenceDate> composite, and non-repeating.

Fixed length, two digits
List 247
OccurrenceDateRole
x554
1
<x554>01</x554> (Date of occurrence)
P.27.70 Date format (deprecated)

An ONIX code indicating the format in which the date is given in <Date>. Optional and not repeatable. Deprecated – where possible, use the dateformat attribute instead.

Fixed length, two digits
List 55
DateFormat
j260
0…1
 
P.27.71 Date

The date specified in the <OccurrenceDateRole> field. Mandatory in each occurrence of the <OccurrenceDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then <DateFormat> indicates the format of the date; if both dateformat attribute and <DateFormat> element are missing, the default format is YYYYMMDDThhmm (local time at the venue). Note that this date format may include a time zone offset (Z for times in UTC, or ±hhmm), and this should always be included where there is any doubt, eg when the event is available online.

As specified by the value in the dateformat attribute, in <DateFormat>, or the default YYYYMMDDThhmm
Date
b306
1
dateformat
<b306>20190405T1830+0200</b306>(6:30pm CEST)
End of Event occurrence date composite
P.27.72 Event status

An ONIX code which specifies the status of a particular occurrence of a promotional event occurrence. Mandatory within each instance of the <EventOccurrence> composite, and non-repeatable.

Fixed length, single character
List 246
EventStatus
x549
1
<x549>C</x549> (Cancelled after having been announced)
P.27.73 Event country

A code identifying a country within which an event occurrence takes place. Optional and non-repeatable. For a physical event, at least one of the <CountryCode> or <RegionCode> elements is required in each instance of <EventOccurrence>. For purely digital events, both must be omitted.

Fixed length, two letters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes List 91
CountryCode
b251
0…1
<b251>DE</b251>
P.27.74 Event region

A code identifying a region within which an event occurrence takes place. Optional and non-repeatable. For a physical event, at least one of the <CountryCode> or <RegionCode> elements is required in each instance of <EventOccurrence>. For purely digital events, both must be omitted.

Variable length code, consisting of upper case letters, with or without a hyphen and further upper case letters or digits. Suggested maximum length 8 characters
List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166-2
RegionCode
b398
0…1
<b398>CN-BJ</b398> (Beijing municipality, China)
P.27.75 Location name

The name of a city or town location within the specified country or region at which an event occurrence takes place. Optional, but required for a physical event and omitted for a purely digital event, and repeatable to provide parallel names for a single location in multiple languages (eg Baile Átha Cliath and Dublin, or Bruxelles and Brussel). It may if necessary include a postal code (eg 10680 Αθήνα, or 20090 Assago). The language attribute is optional for a single instance of <LocationName>, but must be included in each instance if <LocationName> is repeated.

Variable length text, suggested maximum length 100 characters
LocationName
j349
0…n
language
<LocationName>Stephenville</LocationName>
P.27.76 Venue name

The name of the venue at which the event occurrence takes place, for example the name of the bookstore. Optional, but required for a physical event and omitted for a purely digital event.

Variable length text, suggested maximum length 100 characters
VenueName
x551
0…1
language
<VenueName>The Crime Blotter Bookstore</VenueName>
P.27.77 Venue street address

The street address of the named venue. Optional, but typically required for physical events and omitted for a purely digital event. Do not repeat parts of the address specified in <CountryCode>, <RegionCode>, <LocationName> or <VenueName>.

Variable length text, suggested maximum length 200 characters
StreetAddress
x552
0…1
language
<x552>555 Crystal Parkway, Suite 2021, Spar Hill</x552>
P.27.78 Venue note

Free text of a short note related to the venue. Optional, and repeatable to provide parallel notes in multiple languages. The language attribute is optional for a single instance of <VenueNote>, but must be included in each instance if <VenueNote> is repeated.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
VenueNote
x553
0…n
language, textformat
<x553 language="eng">Visitors requiring wheelchair access: please contact the venue in advance.</x553>
P.27.79 Event occurrence description

Free text describing the promotional event occurrence. Optional, and repeatable to provide parallel text in multiple languages. The language attribute is optional for a single instance of <EventDescription>, but must be included in each instance if <EventDescription> is repeated.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
EventDescription
x550
0…n
language, textformat
<EventDescription textformat="05"><p>The author will read excerpts from her new novel <cite>Crimetime</cite>, and answer audience questions.</p></EventDescription>
Supporting resource composite (event occurrence)

An optional group of data elements which together describe a supporting resource related to an occurrence of a promotional event. The composite is repeatable to describe and link to multiple resources. Note that different forms of the same resource (for example a cover image in separate low and high resolution versions) should be specified in a single instance of the composite.

SupportingResource
supportingresource
0…n
P.27.79a to P.27.79r: elements in the Supporting resource composite

P.27.79a to P.27.79r in the <SupportingResource> composite are identical to P.16.1 to P.16.14 specified in Group P.16.

End of Supporting resource composite (event occurrence)
Event occurrence sponsor composite

An optional group of data elements which together identify an organizer or sponsor of an event occurrence. Either an <EventSponsorIdentifier>, or one or other of <PersonName> or <CorporateName>, or both an identifier and a name, must be present in each occurrence of the composite. The composite is repeatable in order to specify multiple organizers and sponsors.

EventSponsor
eventsponsor
0…n
P.27.80 to P.27.84: elements in the Event sponsor composite

P.27.80 to P.27.84 in the <EventSponsor> composite for a single occurrence of the promotional event are identical to P.8.23 to P.8.27 in Group P.8.

End of Event occurrence sponsor composite
Website composite

An optional group of data elements which together identify and provide pointers to a website which is related to the event occurrence – for example a website providing a ticketing service. Repeatable to provide links to multiple websites.

Website
website
0…n
P.27.85 to P.27.87: elements in the Website composite

P.27.85 to P.27.87 in the <Website> composite are identical to P.8.28 to P.8.30 specified in Group P.8.

End of Website composite
End of Event occurrence composite
Supporting resource composite (promotional event)

An optional group of data elements which together describe a supporting resource related to a promotional event. The composite is repeatable to describe and link to multiple resources. Note that different forms of the same resource (for example a cover image in separate low and high resolution versions) should be specified in a single instance of the composite.

SupportingResource
supportingresource
0…n
P.27.87a to P.27.87r: elements in the Supporting resource composite

P.27.87a to P.27.87r in the <SupportingResource> composite are identical to P.16.1 to P.16.14 specified in Group P.16.

End of Supporting resource composite (promotional event)
Event sponsor composite

An optional group of data elements which together identify an organizer or sponsor of an event or series of event occurrences. Either an <EventSponsorIdentifier>, or one or other of <PersonName> or <CorporateName>, or both an identifier and a name, must be present in each occurrence of the composite. The composite is repeatable in order to specify multiple organizers and sponsors.

EventSponsor
eventsponsor
0…n
P.27.88 to P.27.92: elements in the Event sponsor composite

P.27.88 to P.27.92 in the <EventSponsor> composite for a promotional event or series of event occurrences are identical to P.8.23 to P.8.27 in Group P.8.

End of Event sponsor composite
Website composite

An optional group of data elements which together identify and provide pointers to a website which is related to the event in an instance of the <PromotionalEvent> composite. Repeatable to provide links to multiple websites.

Website
website
0…n
P.27.93 to P.27.95: elements in the Website composite

P.27.93 to P.27.95 in the <Website> composite are identical to P.8.28 to P.8.30 specified in Group P.8.

End of Website composite
End of Promotional event composite

End of Promotion detail composite

Block 3: Content detail

Content detail composite

The Content detail block comprises the single data Group P.18. The block as a whole is non-repeating. It is not mandatory within the <Product> record, and is used only when there is a requirement to describe individual chapters or parts within a product in a fully structured way. The more usual ONIX practice is to send a table of contents as text, possibly in XHTML, in Group P.14.

When used, the block should normally contain at least one instance of <ContentItem>. It may be empty only within a partial or ‘block update’ (Notification or update type 04, see P.1.2), when the intention is to remove all previously-supplied content detail.

ContentDetail
contentdetail
0…1

P.18 Content items

In principle, most parts of a complete ONIX description could be nested within a <ContentItem> composite. In Release 3.0, the composite has been updated with changes that follow automatically from changes in the corresponding elements that are used elsewhere in the <Product> record, and some redundant elements have been removed.

Content item composite

A group of data elements which together describe a content item within a product. Optional in any occurrence of the <ContentDetail> composite, but it may be omitted only within a partial or ‘block update’ (Notification or update type 04, see P.1.2) when the intention is to remove all previously supplied content detail. When used normally, it is repeatable for each content item within the product.

ContentItem
contentitem
0…n
P.18.1 Level sequence number

A number which specifies the position of a content item in a multi-level hierarchy of such items. Numbering starts at the top level in the hierarchy, which may represent (eg) chapters in a printed book, and the first item at the top level is numbered 1. Numbers should be assigned solely with a view to the logic of the ONIX description and not in relation to any other characteristics of the items being numbered (such as their actual numbering or their typographical layout in a printed table of contents). So for example, Chapter 2 could have a level sequence number of 3, and the second sub-section within Chapter 2 could be numbered 3.2. <LevelSequenceNumber> is not a required field, but it is strongly recommended for structured tables of contents. If used, it must occur once and only once in each occurrence of the <ContentItem> composite.

Variable length string of positive integers, each successive integer being separated by a period character, suggested maximum length 100 characters
LevelSequenceNumber
b284
0…1
<LevelSequenceNumber>2.24.1</LevelSequenceNumber>
Text item composite

A group of data elements which are specific to text content. Optional, but exactly one of either the <TextItem> composite or the similar <AVItem> composite must occur in a <ContentItem> composite which describes a particular content item. (Similar composites may be defined for other media, and the occurrence of one of them will be mandatory in any <ContentItem> composite.)

TextItem
textitem
0…1
P.18.2 Text item type code

An ONIX code which identifies the nature of a text item. Mandatory in each occurrence of the <TextItem> composite, and non-repeatable.

Fixed length, two digits
List 42
TextItemType
b290
1
<TextItemType>04</TextItemType> (Back matter)
Text item identifier composite

A repeatable group of data elements which together define an identifier of a text item in accordance with a specified scheme. The composite is optional.

TextItemIdentifier
textitemidentifier
0…n
P.18.3 Text item identifier type code

An ONIX code identifying the scheme from which the identifier in <IDValue> is taken. Mandatory in each occurrence of the <TextItemIdentifier> composite, and non-repeating.

Fixed length, two digits
List 43
TextItemIDType
b285
1
<TextItemIDType>01</TextItemIDType> (Proprietary)
P.18.4 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in <TextItemIDType> indicates a proprietary scheme, eg a publisher’s own code. Optional and non-repeating

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<b233>McGraw</b233>
P.18.5 Identifier value

An identifier of the type specified in <TextItemIDType>. Mandatory in each occurrence of the <TextItemIdentifier> composite, and non-repeating.

According to the identifier type specified in <TextItemIDType>
IDValue
b244
1
<b244>12345678</b244>
End of Text item identifier composite
Page run composite

A repeatable group of data elements which together define a run of contiguous pages on which a text item appears. The composite is optional, but may be repeated where the text item covers two or more separate page runs.

PageRun
pagerun
0…n
P.18.6 First page number

The number of the first page of a sequence of contiguous pages. Mandatory in each occurrence of the <PageRun> composite, and non-repeating. Note that here and in the <LastPageNumber> element a page ‘number’ may be Arabic, Roman, or an alphanumeric string (eg L123).

Variable length alphanumeric, suggested maximum length 20 characters
FirstPageNumber
b286
1
<FirstPageNumber>23</FirstPageNumber>
P.18.7 Last page number

The number of the last page of a sequence of contiguous pages (ignoring any blank verso which is left after the last text page). This element is omitted if an item begins and ends on the same page; otherwise it should occur once and only once in each occurrence of the <PageRun> composite.

Variable length alphanumeric, suggested maximum length 20 characters
LastPageNumber
b287
0…1
<b287>35</b287>
End of Page run composite
P.18.8 Number of pages

The page extent of a text item within a paginated product. Optional and non-repeating, but normally expected when the text item is being referenced as part of a structured table of contents.

Positive integer, suggested maximum length 6 digits
NumberOfPages
b061
0…1
<NumberOfPages>12</NumberOfPages>
End of Text item composite
AV item composite

An optional group of data elements which are specific to audio or audiovisual (ie time-based) content. Exactly one of either the <AVItem> composite or the similar <TextItem> composite must occur in a <ContentItem> composite which describes a content item.

AVItem
avitem
0…1
P.18.8a AV item type code

An ONIX code which identifies the nature of an audio or audiovisual content item. Mandatory in each occurrence of the <AVItem> composite, and non-repeatable.

Fixed length, two digits
List 240
AVItemType
x540
1
<x540>03</x540> (Body matter)
AV item identifier composite

A group of data elements which together define an identifier of an audio or audiovisual content item in accordance with a specified identifier scheme. The composite is optional, and repeatable in order to provide multiple identifiers for the content item.

AVItemIdentifier
avitemidentifier
0…n
P.18.8b AV item identifier type code

An ONIX code identifying the scheme from which the identifier in <IDValue> is taken. Mandatory in each occurrence of the <AVItemIdentifier> composite, and non-repeating.

Fixed length, two digits
List 241
AVItemIDType
x541
1
<AVItemIDType>01</TextItemIDType> (Proprietary)
P.18.8c Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be used when, and only when, the code in <AVItemIDType> indicates a proprietary scheme, eg a publisher’s own code. Optional and non-repeating

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<b233>Pearson AVID</b233>
P.18.8d Identifier value

An identifier of the type specified in <AVItemIDType>. Mandatory in each occurrence of the <AVItemIdentifier> composite, and non-repeating.

According to the identifier type specified in <AVItemIDType>
IDValue
b244
1
<b244>12345678</b244>
End of AV item identifier composite
Time run composite

A repeatable group of data elements which together define the time period which an AV item takes up. The composite is optional, but may be repeated where the AV item covers two or more separate periods of time.

TimeRun
timerun
0…n
P.18.8e Start time

The time (relative to the beginning of the product’s audio or audiovisual content) of the beginning of a continuous sequence of audiovisual content. Mandatory in each occurrence of the <TimeRun> composite, and non-repeating.

Hours, minutes and seconds in the form HHHMMSS or HHHMMSScc (hundredths of a second)
StartTime
x542
1
<StartTime>0011206</StartTime> (One hour, 12 minutes and six seconds)
P.18.8f End time

The time (relative to the beginning of the product’s audio or audiovisual content) of the end of a continuous sequence of audio or audiovisual content. Optional in each occurrence of the <TimeRun> composite, and non-repeating.

Hours, minutes and seconds in the form HHHMMSS or HHHMMSScc (hundredths of a second)
EndTime
x543
0…1
<x543>0014154</x543> (One hour, 41 minutes and 54 seconds)
End of Time run composite
P.18.8g Duration of AV item

The duration of an audio or audiovisual item within the time-based content of a product. Optional and non-repeating, but normally expected when the AV content item is being referenced as part of a structured table of contents.

Hours, minutes and seconds in the form HHHMMSS or HHHMMSScc (hundredths of a second)
AVDuration
x544
0…1
<AVDuration>0002948</AVDuration> (29 minutes and 48 seconds)
End of AV item composite
P.18.9 Component type name

The generic name (if any) which is given in the product to the type of section which the content item represents, eg Chapter, Part, Track. Optional and non-repeating; but either this field or a title (in the <TitleDetail> composite), or both, must be present in each occurrence of the <ContentItem>.

Variable length alphanumeric, suggested maximum length 20 characters
ComponentTypeName
b288
0…1
language
<b288>Chapter</b288>
P.18.10 Component number

The number (if any) which is given to the content item in the product, in the form (eg Arabic or Roman) in which it is given in the product. Optional and non-repeating.

Variable length alphanumeric, suggested maximum length 20 characters
ComponentNumber
b289
0…1
<ComponentNumber>XX</ComponentNumber>
Title detail composite (content item)

A repeatable group of data elements which together give the text of a title of a content item and specify its type. Optional.

TitleDetail
titledetail
0…n
P.18.11 to P.18.18a: elements in the Title detail composite

Elements P.18.11 to P.18.18a in the <TitleDetail> composite are identical to P.6.1 to P.6.8a as specified in Group P.6.

End of Title detail composite (content item)
Contributor composite (content item)

A group of data elements which together describe a personal or corporate contributor to a content item. Optional and repeatable.

Contributor
contributor
0…n
P.18.19 to P.18.68a: elements in the Contributor composite

Elements P.18.19 to P.18.68a in the <Contributor> composite are identical to P.7.1 to P.7.50a as specified in Group P.7.

End of Contributor composite (content item)
P.18.68b Contributor statement

Free text showing how the authorship of a content item should be described in an online display, when a standard concatenation of individual contributor elements would not give a satisfactory presentation. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <ContributorStatement>, but must be included in each instance if <ContributorStatement> is repeated. When the <ContributorStatement> field is sent, the receiver should use it to replace all name detail (though not the biographical, date or place details) sent in the <Contributor> composite for display purposes only. The individual name detail must also be sent in the <Contributor> composite for indexing and retrieval.

Variable length text, suggested maximum length 1000 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
ContributorStatement
b049
0…n
language, textformat
<b049>Written and illustrated by Fred and Emily Jackson</b049>
P.18.68c “No authorship” indicator

An empty element that provides a positive indication that a content item has no stated authorship. Optional and non-repeating. Must only be sent in a <ContentItem> composite that has no <Contributor> elements.

XML empty element
NoContributor/
n339/
0…1
<NoContributor/>
Language composite (content item)

An optional and repeatable group of data elements which together represent a language, and specify its role and, where required, whether it is a country variant.

Language
language
0…n
P.18.68d to P.18.68h: elements in the Language composite

Elements P.18.68d to P.18.68h in the <Language> composite are identical to P.10.1 to P.10.4 as specified in Group P.10.

End of Language composite (content item)
Subject composite (content item)

A group of data elements which together specify a subject classification or a subject heading relating to a content item. Optional and repeatable.

Subject
subject
0…n
P.18.69 to P.18.74: elements in the Subject composite

Elements P.18.69 to P.18.74 in the <Subject> composite are identical to P.12.1 to P.12.6 as specified in Group P.12.

End of Subject composite (content item)
Name as subject composite (content item)

An optional and repeatable group of data elements which together represent the name of a person or organization – real or fictional – that is part of the subject of a content item.

NameAsSubject
nameassubject
0…n
P.18.75 to P.18.90v: elements in the Name as subject composite

Elements P.18.75 to P.18.90v in the <NameAsSubject> composite are identical to P.12.7 to P.12.40 as specified in Group P.12.

End of Name as subject composite (content item)
Text content composite (content item)

A group of data elements which together carry text related to a content item. Optional and repeatable.

TextContent
textcontent
0…n
P.18.91 to P.18.99: elements in the Text content composite

Elements P.18.91 to P.18.99 in the <TextContent> composite are identical to P.14.1 to P.14.9 as specified in Group P.14.

End of Text content composite (content item)
Cited content composite (content item)

A group of data elements which together describe a piece of cited content. Optional and repeatable.

CitedContent
citedcontent
0…n
P.18.100 to P.18.110: elements in the Cited content composite

Elements P.18.100 to P.18.110 in the <CitedContent> composite are identical to P.15.1 to P.15.11 as specified in Group P.15.

End of Cited content composite (content item)
Supporting resource composite (content item)

A group of data elements which together describe a supporting resource. Optional and repeatable.

SupportingResource
supportingresource
0…n
P.18.111 to P.18.124: elements in the Supporting resource composite

Elements P.18.111 to P.18.124 in the <SupportingResource> composite are identical to P.16.1 to P.16.14 as specified in Group P.16.

End of Supporting resource composite (content item)
Related work composite (content item)

A group of data elements which together describe a work which has a specified relationship to a content item. Optional and repeatable.

RelatedWork
relatedwork
0…n
P.18.125 to P.18.128: elements in the Related work composite

Elements P.18.125 to P.18.128 in the <RelatedWork> composite are identical to P.22.1 to P.22.4 as specified in Group P.22.

End of Related work composite (content item)
Related product composite (content item)

A group of data elements which together describe a product which has a specified relationship to a content item. Optional and repeatable.

RelatedProduct
relatedproduct
0…n
P.18.129 to P.18.134: elements in the Related product composite

Elements P.18.129 to P.18.134 in the <RelatedProduct> composite are identical to P.23.1 to P.23.6 as specified in Group P.23.

End of Related product composite (content item)
End of Content item composite

End of Content detail composite

Block 4: Publishing detail

Publishing detail composite

The publishing detail block covers data Groups P.19 to P.21, carrying information on the publisher(s), ‘global’ publishing status, and rights attaching to a product. The block as a whole is non-repeating. It is mandatory in any <Product> record unless the <NotificationType> in Group P.1 indicates that the record is an update notice which carries only those blocks in which changes have occurred.

PublishingDetail
publishingdetail
0…1

P.19 Publisher

Group P.19 carries details of the imprint and/or publisher of the product, as well as those of other associated entities, eg co-publishers. It may also carry details of a contact responsible for responding to promotional or sales queries about the product.

The XML Schema or DTD makes it mandatory for either <Imprint> or <Publisher> or both to be sent in any occurrence of the <PublishingDetail> block. However, inclusion of <ProductContact> is optional.

Imprint or brand composite

An optional group of data elements which together identify an imprint or brand under which the product is marketed. The composite must carry either a name identifier or a name or both, and is repeatable to specify multiple imprints or brands.

Imprint
imprint
0…n
Imprint or brand identifier composite

A group of data elements which together define the identifier of an imprint name. Optional, but mandatory if the <Imprint> composite does not carry an <ImprintName>. The composite is repeatable in order to specify multiple identifiers for the same imprint or brand.

ImprintIdentifier
imprintidentifier
0…n
P.19.1 Imprint identifier type

An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <ImprintIdentifier> composite.

Fixed length, two digits
List 44
ImprintIDType
x445
1
<x445>01</x445> (Proprietary)
‘Proprietary’ in this context indicates the code list from which <IDValue> is drawn is proprietary; it is not an indicator of trademark or proprietary rights held over the brand or imprint name itself.
P.19.2 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <ImprintIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<IDTypeName>XYZ Publishers Imprint Code</IDTypeName>
P.19.3 Identifier value

A code value taken from the scheme specified in the <ImprintIDType> element. Mandatory in each occurrence of the <ImprintIdentifier> composite, and non-repeating.

Determined by the scheme specified in <ImprintIDType>
IDValue
b244
1
<b244>XYZ123</b244>
End of Imprint or brand identifier composite
P.19.4 Imprint or brand name

The name of an imprint or brand under which the product is issued, as it appears on the product. Mandatory if there is no imprint identifier in an occurrence of the <Imprint> composite, and optional if an imprint identifier is included. Non-repeating.

Variable length text, suggested maximum length 100 characters
ImprintName
b079
0…1
language, collationkey
<ImprintName>Secker &amp; Warburg</ImprintName> (note ‘&’ is a reserved character in XML)
End of Imprint or brand composite
imprint name plus a proprietary list code
using Reference names
<Imprint>
    <ImprintIdentifier>
        <ImprintIDType>01</ImprintIDType>
        <IDTypeName>HCP UK List Codes<IDTypeName>
        <IDValue>HCF</IDValue>
    </ImprintIdentifier>
     <ImprintName>Harper</ImprintName>
</Imprint>
using Short tags
<imprint>
    <imprintidentifier>
        <x445>01</x445>Proprietary list gives
        <b233>HCP UK List Codes</b233>more granular details
        <b244>HCF</b244>where business units
    </imprintidentifier>share an imprint/brand
    <b079>Harper</b079>
</imprint>
Publisher composite

An optional group of data elements which together identify an entity which is associated with the publishing of a product. The composite allows additional publishing roles to be introduced without adding new fields. Each occurrence of the composite must carry a publishing role code and either a name identifier or a name or both, and the composite is repeatable in order to identify multiple entities.

Publisher
publisher
0…n
P.19.5 Publishing role code

An ONIX code which identifies a role played by an entity in the publishing of a product. Mandatory in each occurrence of the <Publisher> composite, and non-repeating.

Fixed length, two digits
List 45
PublishingRole
b291
1
<PublishingRole>02</PublishingRole> (Co-publisher)
Publisher identifier composite

An optional group of data elements which together define the identifier of a publisher name. Optional, but mandatory if the <Publisher> composite does not carry a <PublisherName>. The composite is repeatable in order to specify multiple identifiers for the same publisher.

PublisherIdentifier
publisheridentifier
0…n
P.19.6 Publisher identifier type

An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <PublisherIdentifier> composite.

Fixed length, two digits
List 44
PublisherIDType
x447
1
<x447>03</x447> (Deutsche Bibliothek publisher identifier)
P.19.7 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <PublisherIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<b233>GBIPublisherCode</b233> (GBI is a placeholder for the ‘owner’ of a proprietary code scheme)
P.19.8 Identifier value

A code value taken from the scheme specified in the <PublisherIDType> element. Mandatory in each occurrence of the <PublisherIdentifier> composite, and non-repeating.

Determined by the scheme specified in <PublisherIDType>
IDValue
b244
1
<IDValue>17499</IDValue> (Börsenverein Verkehrsnummer)
End of Publisher identifier composite
use of public identifier for publisher
using Reference names
<Publisher>
    <PublishingRole>01<PublishingRole>
    <PublisherIdentifier>
        <PublisherIDType>19</PublisherIDType>
        <IDValue>09</IDValue>
    </PublisherIdentifier>
    <PublisherName>小学館</PublisherName>
</Publisher>
using Short tags
<publisher>
    <b291>01<b291>Publisher
    <publisheridentifier>
        <x447>19</x447>Japanese Publisher Identifier
        <b244>09</b244>
    </publisheridentifier>
    <b081>小学館</b081>Shogakukan
</publisher>
P.19.9 Publisher name

The name of an entity associated with the publishing of a product. Mandatory if there is no publisher identifier in an occurrence of the <Publisher> composite, and optional if a publisher identifier is included. Non-repeating.

Variable length text, suggested maximum length 100 characters
PublisherName
b081
0…1
language, collationkey
<b081>Reed International Books</b081>
Funding composite

An optional group of data elements which together identify a grant or award provided by the entity specified as a funder in an occurence of the <Publisher> composite, to subsidise research or publication. Repeatable when the funder provides multiple grants or awards. Used only when <PublishingRole> indicates the role of a funder.

Funding
funding
0…n
Funding identifier composite

A group of data elements which together identify a particular grant or award. At least one <FundingIdentifier> composite must occur in each instance of the <Funding> composite. Repeatable when the grant or award has multiple identifiers.

FundingIdentifier
fundingidentifier
1…n
P.19.9a Funding identifier type code

An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <FundingIdentifier> composite, and non-repeating.

Fixed length, two digits
List 228
FundingIDType
x523
1
<FundingIDType>01</FundingIDType> (proprietary)
P.19.9b Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <FundingIDType> element indicates a proprietary scheme, eg a funder’s own code. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<IDTypeName>Wellcome Grant Number</IDTypeName>
P.19.9c Identifier value

An identifier of the type specified in the <FundingIDType> element. Mandatory in each occurrence of the <FundingIdentifier> composite, and non-repeating.

According to the identifier type specified in <FundingIDType>
IDValue
b244
1
<b244>2015-16674</b244>
End of Funding identifier composite
End of Funding composite
Website composite

An optional group of data elements which together identify and provide a pointer to a website which is related to the publisher identified in an occurrence of the <Publisher> composite. Repeatable in order to provide links to multiple websites.

Website
website
0…n
P.19.10 Website purpose

An ONIX code which identifies the role or purpose of the website which is linked through the <WebsiteLink> element. Optional and non-repeating.

Fixed length, two digits
List 73
WebsiteRole
b367
0…1
<WebsiteRole>18</WebsiteRole> (Publisher’s consumer-facing website)
P.19.11 Website description

Free text describing the nature of the website which is linked through the <WebsiteLink> element. Optional, and repeatable to provide parallel descriptive text in multiple languages. The language attribute is optional for a single instance of <WebsiteDescription>, but must be included in each instance if <WebsiteDescription> is repeated.

Variable length text, suggested maximum length 300 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
WebsiteDescription
b294
0…n
language, textformat
 
End of Website composite
End of Publisher composite
imprint and publisher names, with links to corporate websites
using Reference names
<Imprint>
     <ImprintName>Éditions Grasset</ImprintName>
<Imprint>
<Publisher>
    <PublishingRole>01</PublishingRole>
    <PublisherName>Hachette Livres</PublisherName>
    <Website>
        <WebsiteRole>01</WebsiteRole>
        <WebsiteLink>http://www.hachette.com</WebsiteLink>
    </Website>
    <Website>
        <WebsiteRole>01</WebsiteRole>
        <WebsiteDescription>Site web pour la marque d’éditeur</WebsiteDescription>
        <WebsiteLink>http://www.grasset.fr</WebsiteLink>
    </Website>
</Publisher>
<CityOfPublication>Paris</CityOfPublication>
<CountryOfPublication>FR</CountryOfPublication>
using Short tags
<imprint>
     <b079>Éditions Grasset</b079>
<imprint>
<publisher>
    <b291>01</b291Publisher
    <b081>Hachette Livres</b081>
    <website>
        <b367>01</b367>Corporate website
        <b295>http://www.hachette.com</b295>
    </website>
    <website>
        <b367>01</b367>Corporate website
        <b294>Site web pour la marque d’éditeur</b294>For the publisher’s imprint/​brand
        <b295>http://www.grasset.fr</b295>
    </website>
</publisher>
<b209>Paris</b209>
<b083>FR</b083>
P.19.13 City or town of publication

The name of a city or town associated with the imprint or publisher. Optional, and repeatable if parallel names for a single location appear on the title page in multiple languages, or if the imprint carries two or more cities of publication.

A place of publication is normally given in the form in which it appears on the title page. If the place name appears in more than one language, <CityOfPublication> may be repeated. The language attribute is optional with a single instance of <CityOfPublication>, but must be included in each instance if <CityOfPublication> is repeated.

Variable length text, suggested maximum length 50 characters
CityOfPublication
b209
0…n
language
<CityOfPublication>New York</CityOfPublication>
P.19.14 Country of publication

A code identifying the country where the product is published. Optional and non-repeating.

Fixed length, two letters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes List 91
CountryOfPublication
b083
0…1
<b083>US</b083>
Product contact composite

An optional group of data elements which together specify an organization (which may or may not be the publisher) responsible for dealing with enquiries related to the product. Repeatable in order to specify multiple responsible organisations.

ProductContact
productcontact
0…n
P.19.15 Product contact role

An ONIX code which identifies the role played by the product contact in relation to the product – for example answering enquiries related to sales or to promotion.

Fixed length, two digits
List 198
ProductContactRole
x482
1
  
Product contact identifier composite

A group of data elements which together define an identifier of the product contact. The composite is optional, and repeatable if more than one identifier of different types is sent; but either a <ProductContactName> or a <ProductContactIdentifier> must be included.

ProductContactIdentifier
productcontactidentifier
0…n
P.19.16 Product contact identifier type

An ONIX code identifying a scheme from which an identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <ProductContactIdentifier> composite, and non-repeating.

Fixed length, two digits
List 44
ProductContactIDType
x483
1
  
P.19.17 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <ProductContactIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum 50 characters
IDTypeName
b233
0…1
language
  
P.19.18 Identifier value

An identifier of the type specified in the <ProductContactIDType> element. Mandatory in each occurrence of the <ProductContactIdentifier> composite, and non-repeating.

According to the identifier type specified in <ProductContactIDType>
IDValue
b244
1
  
End of Product contact identifier composite
P.19.19 Product contact name

The name of the product contact organization, which should always be stated in a standard form. Optional and non-repeating; but either a <ProductContactName> element or a <ProductContactIdentifier> composite must be included.

Variable length text, suggested maximum 50 characters
ProductContactName
x484
0…1
<ProductContactName>Little Brown Book Group</ProductContactName>
P.19.20 Contact name

Free text giving the name, department, etc for a contact person in the product contact organization who is responsible for the product. Optional and non-repeating.

Variable length text, suggested maximum 300 characters
ContactName
x299
0…1
<x299>Jackie Brown</x299>
P.19.20a Product contact telephone number

A telephone number of the contact person in the product contact organization who is responsible for the product, wherever possible including the plus sign and the international dialling code. Optional, and repeatable to provide multiple numbers for the same contact.

Variable length text, suggested maximum length 20 characters
TelephoneNumber
j270
0…n
<TelephoneNumber>+44 20 7946 0921</TelephoneNumber>
P.19.21 Product contact e-mail address

A text field giving the e-mail address for a contact person in the product contact organization who is responsible for the product. Optional and non-repeating.

Variable length text, suggested maximum 100 characters
EmailAddress
j272
0…1
<j272>jackie.brown@bigpublisher.co.uk</j272>
End of Product contact composite

P.20 Global publishing status and dates / copyright

Group P.20 covers elements that specify a publishing status and any publishing dates which apply ‘globally’ to a product, ie which are not specific to a geographical market. An important difference between ONIX 3.0 and all earlier releases is that it is no longer mandatory (thought it is still recommended as good practice) to specify a ‘global’ status and pubdate, provided that a <ProductSupply> block carries this information in respect of each territorial market in which a product is distributed. It is expected that for those markets that are essentially international, eg the English-speaking countries, ONIX senders will prefer to provide publishing status and dates at market level in P.25 and also provide a global status and pubdate in P.20. However, for those markets that are essentially national, ONIX feeds can continue to use Group P.20 (alone).

For all markets, any copyright statement attached to a product should continue to be carried in P.20, if it is required in the ONIX record.

P.20.1 Publishing status

An ONIX code which identifies the status of a published product. Optional and non-repeating, but required if publishing status is not identified at market level in <MarketPublishingDetail> (P.25).

Where the element is sent by a sender who is not the publisher, based on information that has been previously supplied by the publisher, it is strongly recommended that it should carry a datestamp attribute to indicate its likely reliability. See Section 1 for further details of the datestamp attribute.

Fixed length, two digits
List 64
PublishingStatus
b394
0…1
<PublishingStatus>02</PublishingStatus> (Forthcoming)

Note the typical progression of publishing status, from announcement to out-of-print, through the life cycle of a product. The pale shaded area shows when the product is ‘orderable’ from the publisher or the publisher’s distributor, though if the product is ‘Forthcoming’ (and is later postponed indefinitely or cancelled) or the product ‘Out of stock indefinitely’, the order may not be fulfilled. Statuses ‘Withdrawn’, ‘Recalled’ are not shown on the diagram, but would normally be preceded by ‘Active’. Statuses ‘No longer our product’ and ‘Unknown’ are also not shown. In exceptional circumstances, products that are ‘Out of print’ are occasionally reactivated, returned to ‘Active’ status, via a reprint or print-on-demand decision, and a ‘Cancelled’ product may be reviewed and the title re-announced:

[out of stock, no reprint orders pending] [out of stock, no reprint orders pending] Out of print (07) announce Forthcoming (02) publish on time? publish on time? [publish] [publish] Active (04) Out of stock indefinitely, RUC (06) [reprint] [reprint] [no reprint] [no reprint] postpone? Cancelled (01) [abandon] [abandon] new date set? new date set? reprint? reprint? Postponed indefinitely (03) [abandon] [abandon] intend to publish? intend to publish? [new date] [no new date] [no new date] [new date set] [new date set] Remaindered (10) [out of stock] [excess stock]

This element and the equivalent <MarketPublishingStatus> in P.25 are frequently confused with <ProductAvailability> in P.26. The latter describes whether the product is available from a particular supplier (eg a distributor or wholesaler) – it is an attribute of the supply chain – whereas the publishing status of a product describes decisions made solely by the publisher or the publisher’s representative in a market. For example, a publisher may decide that a product is ‘out of print’ even while there are many copies available in the supply chain – the OP decision would be reflected in <PublishingStatus> while the continued availability of copies would be reflected in <ProductAvailability>.

P.20.2 Publishing status note

Free text that describes the status of a published product, when the code in <PublishingStatus> is insufficient. Optional, but when used, must be accompanied by the <PublishingStatus> element. Repeatable if parallel notes are provide in multiple languages. The language attribute is optional for a single instance of <PublishingStatusNote>, but must be included in each instance if <PublishingStatusNote> is repeated.

Variable length text, suggested maximum 300 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
PublishingStatusNote
b395
0…n
language, textformat
<b395>Lost contact with publisher</b395>
Publishing date composite

A group of data elements which together specify a date associated with the publishing of the product. Optional, but where known, at least a date of publication must be specified either here (as a ‘global’ pub date) or in <MarketPublishingDetail> (P.25). Other dates related to the publishing of a product can be sent in further repeats of the composite.

PublishingDate
publishingdate
0…n
P.20.3 Publishing date role code

An ONIX code indicating the significance of the date, eg publication date, announcement date, latest reprint date. Mandatory in each occurrence of the <PublishingDate> composite, and non-repeating.

Fixed length, two digits
List 163
PublishingDateRole
x448
1
<x448>01</x448> (Publication date)
Note a date such as a publication date should be interpreted as the ‘global’ publication date.
P.20.4 Date format

An ONIX code indicating the format in which the date is given in <Date>. Optional in each occurrence of the <PublishingDate> composite, and non-repeating. Deprecated – where possible, use the dateformat attribute instead.

Fixed length, two digits
List 55
DateFormat
j260
0…1
<DateFormat>00</DateFormat> (YYYYMMDD)
P.20.5 Date

The date specified in the <PublishingDateRole> field. Mandatory in each occurrence of the <PublishingDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then <DateFormat> indicates the format of the date; if both dateformat attribute and <DateFormat> element are missing, the default format is YYYYMMDD.

As specified by the value in the dateformat attribute, in <DateFormat>, or the default YYYYMMDD
Date
b306
1
dateformat
<Date dateformat="01">199206</Date> (June 1992)
End of Publishing date composite
public announcement date and date work was first published
using Reference names
<PublishingDate>
    <PublishingDateRole>09</PublishingDateRole>Public announcement date
    <Date dateformat="00">20101206</Date>Dateformat=YYYYMMYY
</PublishingDate>
<PublishingDate>
    <PublishingDateRole>11</PublishingDateRole>Year first published
    <Date dateformat="05">1972</Date>Dateformat=YYYY
</PublishingDate>
using Short tags
<publishingdate>
    <x448>09</x448>
    <b306 dateformat="00">20101206</b306>
</publishingdate>
<publishingdate>
    <x448>11</x448>
    <b306 dateformat="05">1972</b306>
</publishingdate>
P.20.6 Latest reprint number

The number of the most recent reprint (or current ‘impression number’) of the product. Optional and non-repeating. This element is used only in certain countries where there is a legal requirement to record reprints.

Positive integer, suggested maximum four digits
LatestReprintNumber
x446
0…1
<LatestReprintNumber>12</LatestReprintNumber>
Copyright statement composite

An optional and repeatable group of data elements which together represent a copyright or neighbouring right statement for the product. At least one <CopyrightYear> or one instance of the <CopyrightOwner> composite must be sent within an instance of the composite, but it is recommended that all elements in the composite are explicitly populated. The Copyright statement may be repeated to provide a full structured rights statement listing year(s) and rights holder(s).

CopyrightStatement
copyrightstatement
0…n
P.20.6a Copyright statement type

An optional ONIX code indicating the type of right covered by the statement, typically a copyright or neighbouring right. If omitted, the default is that the statement represents a copyright.

Fixed length, one letter
List 219
CopyrightType
x512
0…1
<CopyrightType>P</CopyrightType> (℗ phonogram right)
P.20.7 Copyright year

The copyright year as it appears in a copyright statement on the product. Optional in each occurrence of the <CopyrightStatement> composite but may be omitted only if <CopyrightOwner> is present, and repeatable if several years or periods are listed.

As specified by the value in the dateformat attribute, or the default of YYYY if the attribute is missing)
CopyrightYear
b087
0…n
dateformat
<b087 dateformat="11">20032008</b087> (2003–2008)
Copyright owner composite

A repeatable group of data elements which together name a copyright owner. Optional, but may be omitted only if <CopyrightYear> is present. Each occurrence of the <CopyrightOwner> composite must carry a single name (personal or corporate), or an identifier, or both.

CopyrightOwner
copyrightowner
0…n
Copyright owner identifier composite

A group of data elements which together represent a coded identification of a copyright owner. Optional, and repeatable if sending more than one identifier of different types. May be sent either instead of or as well as a name.

CopyrightOwnerIdentifier
copyrightowneridentifier
0…n
P.20.8 Copyright owner identifier type

An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <CopyrightOwnerIdentifier> composite, and non-repeating.

Fixed length, two digits
List 44
CopyrightOwnerIDType
b392
1
<CopyrightOwnerIDType>18</CopyrightOwnerIDType> (LCCN)
P.20.9 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <CopyrightOwnerIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
 
P.20.10 Identifier value

A code value taken from the scheme specified in the <CopyrightOwnerIDType> element. Mandatory in each occurrence of the <CopyrightOwnerIdentifier> composite, and non-repeating.

Determined by the scheme specified in <CopyrightOwnerIDType>
IDValue
b244
1
<IDValue>0000000121475396</IDValue>
End of Copyright owner identifier composite
P.20.11 Person name

The name of a person, used here for a personal copyright owner. Optional and non-repeating. Each occurrence of the <CopyrightOwner> composite may carry a single name (personal or corporate), or an identifier, or both a name and an identifier.

Variable length text, suggested maximum length 100 characters
PersonName
b036
0…1
collationkey, language, textscript
<PersonName>James J. Johnson III</PersonName>
P.20.12 Corporate name

The name of a corporate body, used here for a corporate copyright owner. Optional and non- repeating. Each occurrence of the <CopyrightOwner> composite may carry a single name (personal or corporate), or an identifier, or both a name and an identifier.

Variable length text, suggested maximum length 200 characters
CorporateName
b047
0…1
collationkey, language, textscript
<CorporateName>Johnson &amp; Johnson Inc</CorporateName> (note this is represented as ‘Johnson &amp; Johnson Inc’, since & is a reserved character in XML)
End of Copyright owner composite
End of Copyright statement composite

P.21 Territorial rights and other sales restrictions

Release 3.0 allows rights to be specified for any geographical territory. Group P.21 details the rights that the publisher chooses to exercise in the product described by the ONIX record. These may be different from (narrower than) the publication rights owned by the publisher in the underlying work, and may be different from (broader than) the distribution rights held by a particular supplier or group of suppliers in a market (see Group P.24). The P.21 sales rights should be a subset of (or the same as) the publication rights owned by the publisher, and the P.24 market should be a subset of (or the same as) the sales rights. Note that ONIX for Books says nothing directly about the publisher’s publication rights, except in so far as they are reflected in the sales rights.

The aim is to provide precise and reliable geographical rights information that can be used in a computer system to determine whether a product can or cannot be sold in a particular territory. There are no defaults. If no information is known about some range of territories, this should be stated explicitly using the <ROWSalesRightsType> data element.

The <SalesRights> composite allows rights to be specified as exclusive or non-exclusive or not-for-sale in any combination of countries or regions. It is also possible to specify rights as ‘worldwide’ or ‘worldwide with specified exclusions’ if this enables them to be stated more concisely.

The composite also allows details of an equivalent product to be sent in respect of a territory in which the product described in the ONIX record is not for sale. This information is particularly helpful in enabling international online booksellers to ensure that territorial rights are correctly identified and observed.

Special note on US and UK ‘Open Market’, and UK ‘Airport’ or ‘Airside’ editions. It is expected that such editions, like any others, should carry a full statement of the territories in which they are available for sale. If it is desired, as a matter of convenience, to refer to them as ‘Open Market’ or ‘Airside’, this should be additional to, not instead of, a full territorial rights statement, and should be handled through the <TradeCategory> element in Group P.3. Coding for ‘UK Airports’ and ‘UK Airside’ is included in the <Territory> composite, as these need to be distinguished as specific ‘territories’, but there should be no coding for ‘Open Market’ within this data element group.

Additional guidance on the description of sales rights in ONIX 3.0 will be found in a separate document ONIX for Books Product Information Message: How to Specify Markets and Suppliers in ONIX 3.

Sales rights composite

An optional and repeatable group of data elements which together identify territorial sales rights which a publisher chooses to exercise in a product. When specifying a territory in which the product is not for sale, the publisher and product ID for an edition which is available in the specified territory can optionally be included. (In previous releases, this functionality was provided in a <NotForSale> composite, which is now redundant and has been deleted.) See examples at the end of the sales rights composite.

SalesRights
salesrights
0…n
P.21.1 Sales rights type code

An ONIX code which identifies the type of sales right or exclusion which applies in the territories which are associated with it. Mandatory in each occurrence of the <SalesRights> composite, and non-repeating. Values include: for sale with exclusive rights, for sale with non-exclusive rights, not for sale.

Fixed length, two digits
List 46
SalesRightsType
b089
1
<SalesRightsType>02</SalesRightsType> (For sale with non-exclusive rights in the specified territory)
Territory composite

A group of data elements which together identify a territory in which the rights specified in <SalesRightsType> are applicable. Mandatory in each occurrence of the <SalesRights> composite, and non-repeating.

Territory
territory
1

Note the nesting of countries and sub-national regions within the <Territory> composite. Do not exclude smaller geographical areas that have not been included as part of a larger geographical unit. The rights specified apply within the shaded area. Supra-national regions that are included may have both countries and regions excluded:

Supra-national Regions included Countries and Supra-national Regions excluded Countries included Sub-national Regions excluded Sub-national Regions included

The only supra-national region that may be used is WORLD.

P.21.2 Countries included

One or more ISO standard codes identifying countries included in the territory. Successive codes must be separated by spaces. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

One or more fixed-length codes, each consisting of two upper case letters, and with successive codes being separated by spaces. Suggested maximum length 750 characters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes List 91
CountriesIncluded
x449
0…1
<CountriesIncluded>US CA</CountriesIncluded> (USA and Canada)
P.21.3 Regions included

One or more ONIX codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg World, Northern Ireland, Australian Capital Territory. Successive codes must be separated by spaces. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite. Note that US States have region codes, while US overseas territories have distinct ISO Country Codes.

One or more variable-length codes, each consisting of upper case letters, with or without a hyphen and further upper case letters or digits, and with successive codes being separated by spaces. Suggested maximum length 750 characters
List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166-2
RegionsIncluded
x450
0…1
<x450>WORLD</x450> (Whole world)
<x450>GB-ENG GB-SCT GB-WLS</x450> (UK excluding Northern Ireland and islands)
P.21.4 Countries excluded

One or more ISO standard codes identifying countries excluded from the territory. Successive codes must be separated by spaces. Optional and non-repeating, and can only occur if the <RegionsIncluded> element is also present and includes a supra-national region code (such as ‘World’).

One or more fixed-length codes, each consisting of two upper case letters, and with successive codes being separated by spaces. Suggested maximum length 750 characters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
ISO 3166-1 two-letter country codes List 91
CountriesExcluded
x451
0…1
<CountriesExcluded>US CA</CountriesExcluded> (Excludes USA and Canada)
P.21.5 Regions excluded

One or more ONIX codes identifying regions excluded from the territory. Successive codes must be separated by spaces. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code (such as ‘World’).

One or more variable-length codes, each consisting of upper case letters, with or without a hyphen and further upper case letters or digits, and with successive codes being separated by spaces. Suggested maximum length 750 characters
List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166-2
RegionsExcluded
x452
0…1
<x452>GB-NIR</x452> (Excludes Northern Ireland)
End of Territory composite
Sales restriction composite

A group of data elements which together identify a non-territorial sales restriction which a publisher applies to a product within a particular territory. Optional, and repeatable if more than a single restriction applies.

SalesRestriction
salesrestriction
0…n
P.21.5a Sales restriction type code

An ONIX code which identifies a non-territorial sales restriction. Mandatory in each occurrence of the <SalesRestriction> composite, and non-repeating.

Fixed length, two digits
List 71
SalesRestrictionType
b381
1
<b381>04</b381> (Retailer exclusive)
Sales outlet composite

An optional group of data elements which together identify a sales outlet to which a restriction is linked. Each occurrence of the composite must include a <SalesOutletIdentifier> composite or a <SalesOutletName> or both. Repeatable in order to identify multiple sales outlets subject to the restriction.

SalesOutlet
salesoutlet
0…n
Sales outlet identifier composite

An optional group of data elements which together represent a coded identification of an organization, used here to identify a sales outlet. Repeatable in order to specify multiple identifiers for the same sales outlet.

SalesOutletIdentifier
salesoutletidentifier
0…n
P.21.5b Sales outlet identifier type

An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <SalesOutletIdentifier> composite, and non-repeating.

Fixed length, two digits
List 102
SalesOutletIDType
b393
1
<b393>03</b393> (ONIX sales outlet ID code)
P.21.5c Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <SalesOutletIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
 
P.21.5d Identifier value

A code value taken from the scheme specified in the <SalesOutletIDType> element. Mandatory in each occurrence of the <SalesOutletIdentifier> composite, and non-repeating.

Determined by the scheme specified in <SalesOutletIDType>
IDValue
b244
1
<b244>GOS</b244> (Blinkbox)
End of Sales outlet identifier composite
P.21.5e Sales outlet name

The name of a wholesale or retail sales outlet to which a sales restriction is linked. Non-repeating.

Variable length text, suggested maximum length 200 characters
SalesOutletName
b382
0…1
language
<SalesOutletName>Marks &amp; Spencer</SalesOutletName> (note ‘&’ is a reserved character in XML)
End of Sales outlet composite
P.21.5f Sales restriction note

A free text field describing an ‘unspecified’ restriction, or giving more explanation of a coded restriction type. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <SalesRestrictionNote>, but must be included in each instance if <SalesRestrictionNote> is repeated.

Variable length text, suggested maximum length 300 characters. XHTML is enabled in this element – see Using XHTML, HTML or XML with ONIX text fields
SalesRestrictionNote
x453
0…n
language, textformat
 
P.21.5g Start date

The date from which a sales restriction is effective. Optional and non-repeating.

As specified by the value in the dateformat attribute, or the default of YYYYMMDD if the attribute is missing
StartDate
b324
0…1
dateformat
<StartDate>20090327</StartDate>
P.21.5h End date

The date until which a sales restriction is effective. Optional and non-repeating.

As specified by the value in the dateformat attribute, or the default of YYYYMMDD if the attribute is missing
EndDate
b325
0…1
dateformat
<b325 dateformat="00">20090930</b325>
End of Sales restriction composite
temporary retailer-exclusive sales restriction
using Reference names
<SalesRights>
    <SalesRightsType>01</SalesRightsType>
    <Territory>
        <CountriesIncluded>AS GU MH MP PH PR UM US VI​</CountriesIncluded>
    </Territory>
    <SalesRestriction>
        <SalesRestrictionType>04</SalesRestrictionType>
        <SalesOutlet>
            <SalesOutletIdentifier>
                <SalesOutletIDType>03</SalesOutletIDType>
                <IDValue>BKM</IDValue>
            </SalesOutletIdentifier>
        </SalesOutlet>
        <SalesRestrictionNote>For sale only through Books-a-Million until October 2011</SalesRestrictionNote>
        <EndDate dateformat="00">20110930</EndDate>
    </SalesRestriction>
</SalesRights>
<ROWSalesRightsType>06</ROWSalesRightsType>
using Short tags
<salesrights>
    <b089>01</b089>For sale, exclusive
    <territory>
        <x449>AS GU MH MP PH PR UM US VI​</x449>‘US market’
    </territory>
    <salesrestriction>
        <b381>04</b381>But exclusive to retailer
        <salesoutlet>
            <salesoutletidentifier>
                <b393>03</b393>ONIX outlet ID code
                <b244>BKM</b244>Books-a-Million
            </salesoutletidentifier>
        </salesoutlet>
        <x453>For sale only through Books-a-Million until October 2011</x453>
        <b325 dateformat="00">20110930</b325>Restriction ends. After expiry, book will be for sale throughout stated salesrights territory
    </salesrestriction>
</salesrights>
<x456>06</x456>NFS in ROW (publisher lacks rights)
Equivalent product identifier composite

An optional group of data elements which together define the identifier of a product in accordance with a specified scheme. Used here only if <SalesRightsType> has a value indicating ‘not for sale’, in order to specify an equivalent product which is available to be sold in the territory in question. Repeatable with different identifiers for the same product.

ProductIdentifier
productidentifier
0…n
P.21.6 Product identifier type code

An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <ProductIdentifier> composite, and non-repeating.

Fixed length, two digits
List 5
ProductIDType
b221
1
<ProductIDType>03</ProductIDType> (GTIN-13)
P.21.7 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <ProductIDType> element indicates a proprietary scheme, eg a wholesaler’s own code. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<IDTypeName>KNO</IDTypeName>
P.21.8 Identifier value

An identifier of the type specified in the <ProductIDType> element. Mandatory in each occurrence of the <ProductIdentifier> composite, and non-repeating.

According to the identifier type specified in <ProductIDType>
IDValue
b244
1
<b244>9780330413206</b244>
End of Equivalent product identifier composite
P.21.9 Publisher name

The name of the publisher of an equivalent product which is available in the territory specified in the <SalesRights> composite, used only when <SalesRightsType> has a value indicating ‘not for sale’. Optional and non-repeating. Except where they are essential to the recognized form of the name, it is recommended that suffixes denoting incorporation (‘Co’, ‘Inc’, ‘Ltd’, ‘SA’, ‘GmbH’ etc) should be omitted.

Variable length text, suggested maximum length 100 characters
PublisherName
b081
0…1
language, collationkey
<b081>Reed International Books</b081>
End of Sales rights composite
P.21.10 Rest of World sales rights type code

An ONIX code describing the sales rights applicable in territories not specifically associated with a sales right within an occurrence of the <SalesRights> composite. Must be preceded by at least one <SalesRights> composite. Optional, but required in all cases where no sales rights type is associated with the region ‘WORLD’, and in all cases where a sales rights type is associated with ‘WORLD’ but with exclusions that are not themselves associated with a sales rights type. Not repeatable. Note the value ‘00’ should be used to indicate where sales rights are genuinely unknown, or are unstated for any reason – in this case, data recipients must not assume anything about the rights that are applicable.

Fixed length, two digits
List 46
ROWSalesRightsType
x456
0…1
<x456>00</x456> (Unknown or unstated)

The extended example below illustrates the use of <SalesRights> and <ROWSalesRightsType>.

exclusive rights in UK, Ireland, Australia, New Zealand, South Africa; not for sale in USA or Canada; non-exclusive rights in rest of world. The ISBN of the edition available in USA and Canada is shown
using Reference names
<SalesRights>
    <SalesRightsType>01</SalesRightsType>
    <Territory>
        <CountriesIncluded>GB IE AU NZ ZA</CountriesIncluded>
    </Territory>
</SalesRights>
<SalesRights>
    <SalesRightsType>03</SalesRightsType>
    <Territory>
        <CountriesIncluded>US CA</CountriesIncluded>
    </Territory>
    <ProductIdentifier>
        <ProductIDType>03</ProductIDType>
        <IDValue>9780123456784</IDValue>
    </ProductIdentifier>
</SalesRights>
<ROWSalesRightsType>02</ROWSalesRightsType>
using Short tags
<salesrights>
    <b089>01</b089>For sale (exclusive rights)
    <territory>
        <x449>GB IE AU NZ ZA</x449>
    </territory>
</salesrights>
<salesrights>
    <b089>03</b089>Not for sale
    <territory>
        <x449>US CA</x449>
    </territory>
    <productidentifier>
        <b221>03</b221>alternative US/Canada GTIN-13
        <b244>9780123456784</b244>
    </productidentifier>
</salesrights>
<x456>02</x456>For sale (non-exclusive) in ROW
worldwide exclusive rights
using Reference names
<SalesRights>
    <SalesRightsType>01</SalesRightsType>
    <Territory>
        <RegionsIncluded>WORLD</RegionsIncluded>
    </Territory>
</SalesRights>
using Short tags
<salesrights>
    <b089>01</b089>For sale (exclusive rights)
    <territory>
        <x450>WORLD</x450>
    </territory>
</salesrights>
exclusive rights in contiguous 48 states of USA only, not for sale elsewhere
using Reference names
<SalesRights>
    <SalesRightsType>01</SalesRightsType>
    <Territory>
        <CountriesIncluded>US</CountriesIncluded>
        <RegionsExcluded>US-AK US-HI</RegionsExcluded>
    </Territory>
</SalesRights>
<ROWSalesRightsType>03</ROWSalesRightsType>
using Short tags
<salesrights>
    <b089>01</b089>For sale (exclusive rights)
    <territory>
        <x449>US</x449>USA (50 states)
        <x452>US-AK US-HI</x452>Excluding Alaska, Hawaii
    </territory>
</salesrights>
<x456>03</x456>Not for sale in ROW
Sales restriction composite

A group of data elements which together identify a non-territorial sales restriction which a publisher applies to a product. Optional and repeatable, but deprecated in this context, in favor of using <SalesRestriction> within <SalesRights> (P.21.5a to P.21.5h).

SalesRestriction
salesrestriction
0…n
P.21.11 to P.21.18: elements in the Sales restriction composite

Elements P.21.11 to P.21.18 in the <SalesRestriction> composite are identical to P.21.5a to P.21.5h as specified above, but their use is deprecated in this context.

End of Sales restriction composite

End of Publishing detail composite

Block 5: Related material

Related material composite

The related material block covers data Groups P.22 and P.23, providing links to related works and related products. The block as a whole is optional and non-repeating.

None of the individual sections are mandatory within an occurrence of the block. However, in most circumstances, the block should contain at least one instance of <RelatedWork> or <RelatedProduct>. It may be empty only within a partial or ‘block update’ (Notification or update type 04, see P.1.2), when the intention is to remove all previously-supplied information about related works and products.

RelatedMaterial
relatedmaterial
0…1

P.22 Related works

The <RelatedWork> composite in Group P.22 allows the relationship between a product and one or more works to be specified, normally by using an ISTC to identify the work in question.

Related work composite

An optional group of data elements which together describe a work which has a specified relationship to the product described in the ONIX record. Repeatable in order to specify multiple works and their various relationships to the product.

RelatedWork
relatedwork
0…n
P.22.1 Work relation code

An ONIX code which identifies the nature of the relationship between a product and a work. Mandatory in each occurrence of the <RelatedWork> composite, and non-repeating.

Fixed length, two digits
List 164
WorkRelationCode
x454
1
<WorkRelationCode>01</WorkRelationCode> (Manifestation of)
Work identifier composite

A group of data elements which together define an identifier of a work in accordance with a specified scheme. Mandatory in each occurrence of the <RelatedWork> composite, and repeatable if two or more identifiers for the same work are sent using different identifier schemes (eg ISTC and DOI).

WorkIdentifier
workidentifier
1…n
P.22.2 Work identifier type code

An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <WorkIdentifier> composite, and non-repeating.

Fixed length, two digits
List 16
WorkIDType
b201
1
<WorkIDType>11</WorkIDType> (ISTC)
P.22.3 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <WorkIDType> element indicates a proprietary scheme. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
 
P.22.4 Identifier value

An identifier of the type specified in the <WorkIDType> element. Mandatory in each occurrence of the <WorkIdentifier> composite, and non-repeating.

According to the identifier type specified in <WorkIDType>
IDValue
b244
1
<IDValue>0A920080000000FC</IDValue>
End of Work identifier composite
End of Related work composite
this product is a manifestation of a particular work identified by an ISTC
using Reference names
<RelatedWork>
    <WorkRelationCode>01</WorkRelationCode>
    <WorkIdentifier>
        <WorkIDType>11</WorkIDType>
        <IDValue>A022009000001BE9</IDValue>
    </WorkIdentifier>
</RelatedWork>
using Short tags, with additional link to ‘grandparent work’
<relatedwork>
    <x454>01</x454>Is manifestation of
    <workidentifier>
        <b201>11</b201>ISTC
        <b244>A02200900000A654</b244>Of this work
    </workidentifier>
</relatedwork>
<relatedwork>
    <x454>02</x454>Is manifestation of work derived from
    <workidentifier>
        <b201>11</b201>ISTC
        <b244>A02200900000ECDE</b244>Of grandparent work
    </workidentifier>
</relatedwork>

P.23 Related products

The <RelatedProduct> composite in Group P.23 allows a relationship between one product and another to be specified, normally using an ISBN in GTIN-13 format to identify the related product. By general agreement among ONIX user groups, the composite has been substantially reduced in ONIX 3.0 so that it carries only a link to the related product, and little or (ideally) no other detail. This is on the principle that detail of the related product should be accessed through its own metadata, and not repeated in several different places.

Related product composite

An optional group of data elements which together describe a product which has a specified relationship to the product described in the ONIX record. The composite is repeatable in order to specify different products which each have a relationship to the product described.

RelatedProduct
relatedproduct
0…n
P.23.1 Product relation code

An ONIX code which identifies the nature of the relationship between two products, eg ‘replaced-by’. Mandatory in each occurrence of the <RelatedProduct> composite, and repeatable where the related product has multiple types of relationship to the product described.

Fixed length, two digits
List 51
ProductRelationCode
x455
1…n
<x455>06</x455> (Alternative format)
Product identifier composite (related product)

A group of data elements which together define an identifier of a product in accordance with a specified scheme. Mandatory in each occurrence of the <RelatedProduct> composite. Repeatable only if two or more identifiers for the same product are sent using different identifier schemes.

ProductIdentifier
productidentifier
1…n
P.23.2 Product identifier type code

An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <ProductIdentifier> composite, and non-repeating.

Fixed length, two digits
List 5
ProductIDType
b221
1
<ProductIDType>03</ProductIDType> (GTIN-13)
P.23.3 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <ProductIDType> element indicates a proprietary scheme, eg a wholesaler’s own code. Optional and non-repeating.

Variable length text, suggested maximum length 50 characters
IDTypeName
b233
0…1
language
<b233>KNO</b233>
P.23.4 Identifier value

An identifier of the type specified in the <ProductIDType> element. Mandatory in each occurrence of the <ProductIdentifier> composite, and non-repeating.

According to the identifier type specified in <ProductIDType>
IDValue
b244
1
<IDValue>9780300117264</IDValue>
End of Product identifier composite (related product)
P.23.5 Related product form code

An ONIX code which indicates the primary form of a related product. Optional in an occurrence of <RelatedProduct>, and non-repeating. If supplied, should be identical to the <ProductForm> element supplied in the <DescriptiveDetail> block of the full ONIX record describing the related product itself.

Since this and the following element provide data about a related product, ONIX suppliers are cautioned of the risk of contradictory data in separate data feeds. This and the following element should not be supplied unless specifically requested by a particular recipient.

Fixed length, two letters (or the digits 00)
List 150
ProductForm
b012
0…1
<ProductForm>BC</ProductForm> (Paperback book)
P.23.6 Related product form detail

An ONIX code which provides added detail of the medium and/or format of a related product. Optional and repeatable.

Fixed length, four characters: one letter followed by three digits
List 175
ProductFormDetail
b333
0…n
<b333>B206</b333> (Pop-up book)
End of Related product composite
linking an e-publication to the paperback it was based on
using Reference names
<RelatedProduct>
    <ProductRelationCode>13</ProductRelationCode>
    <ProductRelationCode>06</ProductRelationCode>
    <ProductIdentifier>
        <ProductIDType>03</ProductIDType>
        <IDValue>9780007120765</IDValue>
    </ProductIdentifier>
    <ProductForm>BC</ProductForm>
</RelatedProduct>
using Short tags, also with link to alternative hardback format
<relatedproduct>
    <x455>13</x455>Epublication based on
    <x455>06</x455>Alternative format
    <productidentifier>
        <b221>03</b221>GTIN-13
        <b244>9780007120765</b244>Paperback ISBN
    </productidentifier>
    <b012>BC</b012>(Do not use, unless required by recipient)
</relatedproduct>
<relatedproduct>
    <x455>06</x455>Alternative format
    <productidentifier>
        <b221>03</b221>
        <b244>9780007234387</b244>Hardback ISBN
    </productidentifier>
</relatedproduct>

End of Related material composite

Block 8: Production detail

Production detail composite

The Production detail block comprises the single data Group P.28. The block as a whole is non-repeating. It is optional within the <Product> record, and is used only when there is a requirement to communicate specification and file manifest detail relating to intermediary services within the supply chain, for example manufacturing on demand, e-book conversion services or distribution of digital audio. It is not expected to be present in most ONIX messages – though recipients not requiring the data should be able to ignore the entire block if it is supplied.

When used, the block should normally contain at least one instance of <ProductionManifest>. It may be empty only within a partial or ‘block update’ (Notification or update type 04, see P.1.2), when the intention is to remove all previously-supplied manifest detail.

ProductionDetail
productiondetail
0…1

P.28 Production manifest

The Production manifest composite provides specification and file manifest detail for a Product, or – where the Product contains multiple Product parts as listed in Group P.4 – for a single Product part. Optional in any occurrence of the <ProductionDetail> composite, but it may be omitted only within a partial or ‘block update’ (Notification type 04, see P.1.2) when the intention is to remove all previously supplied production detail. When used normally, the composite is repeatable to carry manifests for multiple Product parts.

Each manifest consists of:

  • a <ProductIdentifier> to link the manifest to a specific Product part (this is required only where there are Product parts, and must be omitted when there are none);
  • an optional cover manifest;
  • a mandatory body manifest;
  • optional and repeatable insert manifests;
  • optional and repeatable manifests for supplements (this might include a small PDF ‘booklet’ supplied with a digital audio product, or an item of packaging);
    • supplements may themselved have cover, body and insert manifests.

All manifests, whether for cover, body or inserts, carry specification information for creation of the physical or digital product, and a list of the file resources required. Each file resource can carry details of the resource itself and the URL link from which it can be obtained by the intermediate service provider (with the correct credentials).

Production manifest composite

A group of data elements which together carry manifest details for a single Product or Product part.

ProductionManifest
productionmanifest
0…n
Product identifier composite (product part)

A group of data elements which together specify a product identifier, used here to carry an identifier which must match a product identifier in an instance o