Skip to main content
Skip table of contents

Using ONIX 3.0 for library offers

This article expands on the one describing the ONIX 3.0 feed for booksellers selling to the general public. Here you will find the specific elements for products offered in libraries (the details are in bold in the Description column).

Although the information feeds attempt to reproduce as closely as possible the various constraints associated with the licensing of library offers, the information system handling the feeds must make choices about how it stores, interprets and transmits this information, depending on the parameters of its agreements with the various stakeholders in the library ecosystem. As an indication, you can consult a guide to interpreting library licences.

ONIX 3.0 feed - offers available to libraries

Description of the ONIX 3.0 feed format

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:

"on-site": On-site streaming

"SOGANEL", "DIMEDIA", "PNBONLINE04": Library product licence name.

  </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; 00

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.

Note:  In order to import the library product, it's required to have 2 restrictions. One in 06, for the library product and one in 00 to specify the offer. Exemple:

<!-- For sale in libraries -->

<SalesRestriction>                  

 <SalesRestrictionType>06</SalesRestrictionType></SalesRestriction>

     

<!-- Offer id -->

<SalesRestriction>         <SalesRestrictionType>00</SalesRestrictionType>

 <SalesRestrictionNote>offer_id=250</SalesRestrictionNote>

</SalesRestriction>

  </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>

 


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.