This document is a complement to the document describing the Onix 3.0 feed for book retailers selling to the general public. Here you’ll find the elements specific to the products offered in libraries (specificities are written in bold in the “Description” column).


Even though the information feed tends to reproduce the various constraints associated with licensing library products as faithfully as possible, the information system that received the feeds must make a choice about the way it will store, interpret and transmit this information according to the settings of its agreements with the various entities of the library ecosystem. For information you can consult a guide for interpreting library licenses.


Description of the feed in Onix 3.0 format 

 

Onix 3.0 feed        
Tag (M)andatory
(O)ptional
(R)epeat
Onix Code list Values / Format Description
<ONIXMessage release="3.0">        
<Header>        
...        
</Header>        
<Product>        
  <RecordReference> M 1 Text

Library market products have their own RecordReference and ProductIdentifier. It may be a distinct EAN, ISBN, or a custom key.

Record identifier. Format : Platform prefix + publication's internal identifier – format nature. Ex : « EDGT-5513-3-LIBRARIES »

  ...        
  <ProductIdentifier> R     Library market products have their own RecordReference and ProductIdentifier. It may be a distinct EAN, ISBN, or a custom key.
  <ProductIDType> M 5 01 ; 02 ; 03 ; 15 01 : Custom
02 : ISBN 10
03 : EAN
15 : ISBN 13 
  <IDValue> M   Numbers Identifier's value (ISBN)
  </ProductIdentifier>        
...        
  <DescriptiveDetail> M      
  <ProductForm> M 150

EA; EB; EC; ED

Used only for the consumer market products :

EA : Digital (delivered electronically)

Used for the library market products :

EB : Digital download and online (Digital content available both by download and by online access.)

EC : Digital online (Digital content accessed online only.)

ED : Digital download (Digital content delivered by download only.)

...        
  <ProductFormFeature>  O      
     <ProductFormFeatureType>  O   07; 10

07 : Other system requirements -- library market only

10 : E-publication format version

     <ProductFormFeatureValue>  O   3

3 : If  <ProductFormFeatureType> is 10, then 3 means Epub version 3.

<ProductFormFeatureDescription>  O    

Used for the library market products :

If <ProductFormFeatureType> is 07, then:

"In Situ" : On-site streaming

"Ex Situ" : Off-site streaming

  </ProductFormFeature>  O      
...        
  <EpubUsageConstraint> R      
  <EpubUsageType> M 145 02 ; 03 ; 04 ; 06 ; 07

Used only for the consumer market products :

02 : Print
03 : Copy / paste

Used for the library market products :

04 : Share : If <ProductFormFeatureType> is 07, then type 04 means the following constraint is about the number streamings (on-site or off-site) allowed (see below).

06 : Loans : This constraint is about limit on loans (see below)

07 : Time-limited license : This constraint is about a time-limited offer (see below)

  <EpubUsageStatus> M 146 01; 02; 03 01 : Permitted unlimited
02 : Permitted subject to limit
03 : Prohibited
  <EpubUsageLimit> R      
  <Quantity> O   Number Maximum permitted quantity, ex : 6
  <EpubUsageUnit> O 147 06; 09

06 : Devices

Used for the library market products :

07 : Concurrent users : A maximum of <Quantity> concurrent users is allowed if <EpubUsageType> is 06

09 : Days : The licence is time-limited on <Quantity> days if on a library market product and <EpubUsageType> is 07.

10 : Times : The licence is time-limited on <Quantity> times/activations if on a library market product and <EpubUsageType> is 07.

  </EpubUsageLimit>        
  </EpubUsageConstraint>        
...        
  </DescriptiveDetail>        
...        
  <PublishingDetail>        
  <SalesRestrictions>        
  <SalesRestrictionType> O 71 06; 09

Used for the library market products :

06 : This product is a library market product.

Used only for the consumer market products :

09 : Not for sale to libraries. For backward compatibility issues, the consumer market products will still have this tag with value 09 if the book can't be sold for lending, and the <SalesRestrictionType> tag will be absent if the book can be sold for lending.

  </SalesRestriction>        
  </PublishingDetail>        
  <RelatedMaterial>        
  <RelatedProduct> R      
  <ProductRelationCode> M 51 00 ; 01 ; 02 ; 06 ; 13

 

00 : This library product is related to the following, general public product.

01 : Includes. <Product> includes <RelatedProduct>

02 : Is part of. <Product> is part of <RelatedProduct>
06 : Alternative format. <Product> is also available in the format described in <RelatedProduct>
13 : Epublication based on (print product). <Product> is based on <RelatedProduct>.

  <ProductIdentifier>        
  <ProductIDType> M 5 01 ; 02 ; 03 ; 15 01 : Custom
02 : ISBN 10
03 : EAN
15 : ISBN 13 
  <IDValue> M   Numbers Identifier's value
  </ProductIdentifier>        
  </RelatedProduct>        
  </RelatedMaterial>        
...        
</Product>