EDItEUR logo

ONIX Serials Online Holdings Message Formats

ONIX Serials Online Holdings By-Host

Version 1.0 User Guide

Date issued: January 2007 (with correction February 2007)

This User Guide has been prepared for the EDItEUR / NISO Joint Working Party for the Exchange of Serials Online Holdings Information by Katharina Klemperer, David Martin and Francis Cave. It is designed to accompany a machine-readable specification of the formats written in XML Schema, which has been developed by Francis Cave.

Copyright © 2004-2006 EDItEUR Limited. All rights reserved.

The structural diagrams have been produced using XML Spy™ from Altova GmbH.

General guidance on schema use

This schema provides a formal specification of what constitutes valid use of XML to construct ONIX Serials Online Holdings (SOH) messages. As well as specifying the XML tags that may be used and in what sequence, it also specifies valid ranges of data values for data contained in XML elements, i.e. between matching pairs of XML tags.

The schema to which this document refers comprises two files which together form an XML document that conforms to the XML Schema Recommendation of the World Wide Web Consortium (W3C). The two files are:

Filename  Description of content
ONIX_SerialsOnlineHoldings_Vn.n.xsd  definitions of the message-level element and of complex types specific to SOH messages (the number 'n.n' is the version number of this schema)
ONIX_Serials_CodeLists.xsd  definitions of datatypes common to all ONIX Serials schemas.

For further information see XML Schema Part 1: Structures and XML Schema Part 2: Datatypes.

It is intended that this schema be used to guide implementation of systems for either originating or receiving SOH messages. Used in conjunction with a suitable “schema parser” it may also be used to validate the structure and contents of an individual message.

This schema defines how the substance, or “payload”, of SOH messages are to be represented in XML, but is silent on the question of how this message is to be conveyed from originator to recipient. It is likely that supply chain partners will need to adopt different approaches to message transport, packaging and delivery, depending upon the specific business systems in which this message format is being implemented.

Guidance on reading the message format specifications

In this user guide each successive XML element is illustrated by a graphic which shows any “child” elements. Clicking on any “child” element will take you to the description of that element. Clicking “Back” will return you to the “parent”.

If a “child” element is shown with a solid outline, the element is mandatory in any occurrence of the “parent”. If it is shown with a dotted outline, it is conditional in this context. If it is repeatable, the element box has the legend “1..∞” or “0..∞” immediately below it, indicating “mandatory and repeatable” or “conditional and repeatable”.

All data types are based upon built-in primitive data types defined in XML Schema Part 2: Datatypes. The names of all pre-defined data types are prefixed by “xs:” and include:

xs:stringa string of characters
xs:decimala number that may have a decimal part
xs:intan integer between -2147483648 and +2147483647 inclusive

Introduction

The ONIX Serials Online Holdings (SOH) format defines a family of XML messages used for communicating information about the holdings or coverage of online serial resources from a party that holds or supplies the resources to a party that needs this information in its systems. Please see the ONIX Serials Online Holdings Overview for a general introduction to the SOH messages and their applications. There are two messages currently defined:

Some words or phrases are used throughout ONIX for Serials with a very specific meaning. These are defined in the ONIX for Serials Glossary, and there are direct links from their first appearance in this text to the definition in the glossary.

Related Documents

Please refer to the following documents for a more detailed introduction to the SOH format:

SOH Outline Specification Release 1.0
(http://www.editeur.org/onixserials/050926_ONIX_SOH_overview_1.0.pdf)
ONIX Serials Glossary
(http://www.editeur.org/onixserials/060411_ONIX_Serials_glossary.pdf)

ONIX Serials Online Holdings By-Host

<ONIXSerialsOnlineHoldingsByHost>

 

<ONIXSerialsOnlineHoldingsByHost> is the first and mandatory element in the opening “wrapper” of the message, specifying an ONIX SOH format applied to a holdings list grouped by online service. The element carries a version number as an XML attribute “version”. This release of the User Guide describes version number 1.0, which is expressed as:

 

<ONIXSerialsOnlineHoldingsByHost version=”1.0”>

 

 

<ONIXSerialsOnlineHoldingsByHost>
<Header>

 

Mandatory in each SOH message

Not repeatable

 

The <Header> composite identifies and provides administrative information about the message as a whole. It can also be used to declare various defaults that will be assumed throughout, unless specifically overridden within the body of the message.

 

This composite identifies senders and receivers, including provision for coded <SenderIdentifier> and <AddresseeIdentifier> information, if business partners agree to follow this approach. It also carries a sequence number to enable tracking of exchanges, a date and time stamp, and an indication of whether the message conveys a complete replacement file or an incremental update list.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header>
<Sender>

 

Mandatory within <Header>

Not repeatable

 

The <Sender> composite identifies the sender of the message and provides basic contact details.

 

 

Example:

<Sender>

     <SenderIdentifier>

          <SenderIDType>07</SenderIDType>     07 = “SAN”

          <IDValue>1234567</IDValue>

     </SenderIdentifier>

     <SenderName>Oxford University Press</SenderName>

     <SenderContact>Subscriptions Department</SenderContact>

     <SenderEmail>subscriptions@oupjournals.org</SenderEmail>

</Sender>

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Sender>
<SenderIdentifier>

 

Optional within <Sender>

Not repeatable

 

The <SenderIdentifier> composite specifies a coded identifier for the sender organization. It is optional and non-repeating in any occurrence of the <Sender> composite, but either <SenderIdentifier> or <SenderName> (see below) orboth must be present.

 

The composite allows business partners to use standard or proprietary identifier schemes where these exist.

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Sender> <SenderIdentifier>
<SenderIDType>

 

Mandatory within <SenderIdentifier>

Not repeatable

 

<SenderIDType> is a code indicating the scheme or standard from which the sender identifier is taken. If <SenderIDType> is 01 (proprietary), then the name of the scheme should appear in <IDTypeName>.

 

 

 

Permissible code values:

01 Proprietary

06 EAN-UCC GLN

07 SAN

08 MARC21 organizations code

09 ISIL

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Sender> <SenderIdentifier>
<IDTypeName>

 

Optional within <SenderIdentifier>

Not repeatable

 

The name of the identification scheme from which the <IDValue> is taken, used only when <SenderIDType> is “01” (proprietary).

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Sender> <SenderIdentifier>
<IDValue>

 

Mandatory within <SenderIdentifier>

Not repeatable

 

An identifier of the type specified in <SenderIDType>

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Sender>
<SenderName>

 

Optional within <Sender>

Not repeatable

 

The text name of the sending organization.

 

<Sender> must contain either <SenderIdentifier> or <SenderName> or both.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Sender>
<SenderContact>

 

Optional within <Sender>

Not repeatable

 

The name of a contact person or group at the sending organization.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Sender>
<SenderEmail>

 

Optional within <Sender>

Not repeatable

 

An email address that may be used to contact the sending organization.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header>
<Addressee>

 

Optional within <Header>

Repeatable

 

Identification of the intended recipient organization(s) for the message.

 

May be omitted from broadcast messages or those intended for general distribution.

May be repeated if the same message is sent to multiple recipients

Must contain either <AddresseeIdentifier> or <AddresseeName> or both.

 

 

Example:

<Addressee>

     <AddresseeIdentifier>

          <AddresseeIDType>07</AddresseeIDType>     07 = “SAN”

          <IDValue>1234567</IDValue>

     </AddresseeIdentifier>

     <AddresseeName>Sample University Library</AddresseeName>

     <AddresseeContact>John Q. Librarian</AddresseeContact>

     <AddresseeEmail>jlibrarian@sampleuniv.edu</AddresseeEmail>
</Addressee>

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Addressee>
<AddresseeIdentifier>

 

Optional within <Addressee>

Repeatable for identifiers with different AddresseeIDTypes

 

Identification of an Addressee using a value from a standard or proprietary identification scheme.

Must contain either <AddresseeIdentifier> or <AddresseeName> or both.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Addressee> <AddresseeIdentifier>
<AddresseeIDType>

 

Mandatory within <AddresseeIdentifier>

Not repeatable

 

A code indicating the scheme or standard from which the Addressee identifier is taken. If <AddresseeIDType> is “01” (proprietary), then the name of the scheme should appear in <IDTypeName>.

 

 

 

Permissible code values:

01 Proprietary

06 EAN-UCC GLN

07 SAN

08 MARC21 organizations code

09 ISIL

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Addressee> <AddresseeIdentifier>
<IDTypeName>

 

Optional within <AddresseeIdentifier>

Not repeatable

 

The name of the identification scheme from which <IDValue> is taken, used only when <AddresseeIDType> is “01” (proprietary).

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Addressee> <AddresseeIdentifier>
<IDValue>

 

Mandatory within <AddresseeIdentifier>

Not repeatable

 

An identifier of the type specified in <AddresseeIDType>.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Addressee>
<AddresseeName>

 

Optional within <Addressee>

Not repeatable

 

The text name of the sending organization.

<Addressee> must contain either <AddresseeIdentifier> or <AddresseeName> or both.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Addressee>
<AddresseeContact>

 

Optional within <Addressee>

Not repeatable

 

The name of a contact person or group at the recipient organization.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Addressee>
<AddresseeEmail>

 

Optional within <Addressee>

Not repeatable

 

An email address that may be used to contact the recipient organization.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header>
<MessageNumber>

 

Optional within <Header>

Not repeatable

 

<MessageNumber> carries a sequence number for ONIX messages of this type sent as part of a series of such messages. The element is optional and non-repeating, but its use is recommended to underpin process integrity and to act as a check against missed or repeated messages.

 

 

Example:

<MessageNumber>1</MessageNumber>

 

<ONIXSerialsOnlineHoldingsByHost> <Header>
<MessageRepeat>

 

Optional within <Header>

Not repeatable

 

A sequence number showing how many times this particular message has been sent, starting with “1” for the first transmission of the message.

 

 

Example:

<MessageRepeat>1</MessageRepeat>

 

<ONIXSerialsOnlineHoldingsByHost> <Header>
<SentDateTime>

 

Mandatory within <Header>

Not repeatable

 

A date/time stamp, showing when the message was sent. The following formats may be used:

 

YYYYMMDD

YYYYMMDDTHHMM

YYYYMMDDTHHMMZ (universal time)

YYYYMMDDTHHMM±HHMM (time zone)

 

where “T” and "Z" are constants; that is, the letters T and Z. The recommended form is YYYYMMDDTHHMMZ, using universal time (UTC/GMT).

 

 

Example:

<SentDateTime>20051020T1550Z</SentDateTime>

 

<ONIXSerialsOnlineHoldingsByHost> <Header>
<MessageNote>

 

Optional within <Header>

Not repeatable

 

A free-text note about the message.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header>
<Subscriber>

 

Optional within <Header>

Not repeatable

 

The organization (which may be a single institution or a consortium) whose holdings are listed in the message. <Subscriber> should be included if the message lists the holdings to which a particular organization has access, and that organization is not the sole addressee.

 

<Subscriber> must contain either <SubscriberIdentifier> or <SubscriberName> or both.

 

 

 

Example:

<Subscriber>

     <SubscriberIdentifier>

          <SubscriberIDType>01</SubscriberIDType>     01 = proprietary

          <IDTypeName>Sender’s customer ID</IDTypeName>

          <IDValue>ABC123</IDValue>

     </SubscriberIdentifier>

     <SubscriberName>Sample subscriber</SubscriberName>

</Subscriber>

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Subscriber>
<SubscriberIdentifier>

 

Optional within <Subscriber>

Repeatable if there are multiple identifiers with different SubscriberIDTypes.

 

Identification of a Subscriber using a value from a standard or proprietary identification scheme.

<Subscriber> must contain either <SubscriberIdentifier> or <SubscriberName> or both.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Subscriber> <SubscriberIdentifier>
<SubscriberIDType>

 

Mandatory within <SubscriberIdentifier>

Not repeatable

 

A code indicating the scheme or standard from which the Subscriber identifier is taken. If <SubscriberIDType> is “01” (proprietary), then the name of the scheme should appear in <IDTypeName>.

 

 

 

Permissible code values:

01 Proprietary

06 EAN-UCC GLN

07 SAN

08 MARC21 organizations code

09 ISIL

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Subscriber> <SubscriberIdentifier>
<IDTypeName>

 

Optional within <SubscriberIdentifier>

Not repeatable

 

The name of the identification scheme from which the <IDValue> is taken, used only when <SubscriberIDType> is “01” (proprietary).

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Subscriber> <SubscriberIdentifier>
<IDValue>

 

Mandatory within <SubscriberIdentifier>

Not repeatable

 

An identifier of the type specified in <SubscriberIDType>.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header> <Subscriber>
<SubscriberName>

 

Optional within <Subscriber>

Not repeatable

 

The text name of the Subscriber.

 

<Subscriber> must contain either <SubscriberIdentifier> or <SubscriberName> or both.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <Header>
<CompleteFile>

 

Optional within <Header>

Not repeatable

 

An empty element indicating that this message is a complete replacement list.

 

Each message must contain either <CompleteFile/> or <DeltaFile/> but not both.

 

 

Example:

<CompleteFile/>

 

<ONIXSerialsOnlineHoldingsByHost> <Header>
<DeltaFile>

 

Optional within <Header>

Not repeatable

 

An empty element indicating that the message carries an incremental update list, consisting of new, updated and deleted holdings records, as indicated in <HoldingsRecord> <NotificationType>. Note, however, that all <HoldingsRecord> composites carried within a given delta file must themselves be complete, since updating at individual element level is not supported.

 

Each message must contain either <CompleteFile/> or <DeltaFile/> but not both.

 

 

Example:

<DeltaFile/>

 

<ONIXSerialsOnlineHoldingsByHost>
<HoldingsList>

Mandatory within <ONIXSerialsOnlineHoldingsByHost>

Not repeatable

 

In the ONIX SOH ByHost listing, there is one occurrence of the <HoldingsList> composite for each hosted collection that is represented, plus an occurrence for serial versions available independently of a hosted collection.

 

Either <OnlineService> or <NoOnlineService> must appear in each occurrence of <HoldingsList> in the SOH ByHost message.

 

 

Example:

This skeletal example illustrates the construction of the <HoldingsList> in an SOH ByHost message:

In an SOH AtoZ message, there is one <HoldingsList> for each hosted collection represented in the message. This is followed by Holdings Records for all Serial Versions found in that hosted collection.

At the top of each <HoldingsList> there is an <OnlineService> composite, representing the hosted collection to which the subsequent Serial Versions belong.

If a Serial Version or group of Serial Versions is available independently of a hosted collection, then the <NoOnlineService/> empty element will appear instead of <OnlineService>

There is one <HoldingsRecord> for each Serial Version.

Within <SerialVersion>, the <OnlinePackage> shows coverage information for the Serial Version as found in the <OnlineService> identified at the beginning of the <HoldingsList>.

If a Serial Version is found in more than one hosted collection, it will appear in multiple <HoldingsList> composites.

 

Examples of <OnlineService>, <SerialVersion>, and <OnlinePackage> are found elsewhere in this document.

 

<HoldingsList>

     <OnlineService>description of a hosted collection</OnlineService>

     <HoldingsRecord>     

          <SerialVersion>               first Serial Version in the hosted collection

               <SerialVersionIdentifier>composite</SerialVersionIdentifier>

               <Title>composite: serial version title</Title>

               <Publisher>composite: publisher of serial version</Publisher>

               <OnlinePackage>

                    Coverage information for the Serial Version as found in that hosted collection.

               </OnlinePackage>

          </SerialVersion>

          <SerialVersion>               next Serial Version in the hosted collection

               <SerialVersionIdentifier>composite</SerialVersionIdentifier>

               <Title>composite: serial version title</Title>

               <Publisher>composite: publisher of serial version</Publisher>

               <OnlinePackage>

                    Coverage information for the Serial Version as found in that hosted collection.

               </OnlinePackage>

          </SerialVersion>

          More serial versions from this hosted collection would appear here.

     </HoldingsRecord>

</HoldingsList>

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList>
<OnlineService>

Optional within <HoldingsList>

Not repeatable

 

The hosted collection in which the serial versions in a <HoldingsList> are found. In the ONIX SOH ByHost listing, there is one occurrence of <OnlineService> in each occurrence of <HoldingsList>, except for the case where the serial versions in the Holdings List are available independently of a hosted collection, in which case the empty element <NoOnlineService/> will appear.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService>
<OnlineServiceIdentifier>

 

Optional within <OnlineService>

Repeatable if there are identifiers with different IDTypes

 

Identification of a hosted collection, using a value from a standard or proprietary identification scheme.

 

<OnlineService> must contain either <OnlineServiceIdentifier> or <OnlineServiceName> or both.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <OnlineServiceIdentifier>
<OnlineServiceIDType>

 

Mandatory within <OnlineServiceIdentifier>

Not repeatable

 

A code indicating the scheme or standard from which the Online Service identifier is taken. If <OnlineServiceIDType> is “01” (proprietary), then the name of the scheme should appear in <IDTypeName>.

 

 

 

Permissible code values:

01 Proprietary

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <OnlineServiceIdentifier>
<IDTypeName>

 

Optional within <OnlineServiceIdentifier>

Not repeatable

 

The name of the identification scheme from which the <IDValue> is taken, used only when <OnlineServiceIDType> is “01” (proprietary).

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <OnlineServiceIdentifier>
<IDValue>

 

Mandatory within <OnlineServiceIdentifier>

Not repeatable

 

An identifier of the type indicated in <IDTypeName>

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService>
<OnlineServiceName>

 

Optional within <OnlineService>

Not repeatable

 

The name of the hosted collection.

 

<OnlineService> must contain either <OnlineServiceIdentifier> or <OnlineServiceName> or both.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService>
<Publisher>

 

Optional within <OnlineService>

Repeatable

 

The vendor of a hosted collection, identified either by code or by name

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Publisher>
<PublishingRole>

 

Mandatory within <Publisher>

Not repeatable

 

The role of the publisher; in this context, always “05” (host/disributor on electronic content)

 

Permissible code values:

05 Host/distributor of electronic content

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Publisher>
<PublisherIdentifier>

 

Optional within <Publisher>

Repeatable if there are multiple identifiers with different PublisherIDTypes.

 

Identification of a publisher using a value from a standard or proprietary identification scheme.

 

<Publisher> must contain either <PublisherIdentifier> or <PublisherName> or both.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Publisher> <PublisherIdentifier>
<PublisherIDType>

 

Mandatory within <PublisherIdentifier>

Not repeatable

 

A code indicating the scheme or standard from which the publisher identifier is taken. If <PublisherIDType> is “01” (proprietary), then the name of the scheme should appear in <IDTypeName>.

 

 

 

Permissible code values:

01 Proprietary

06 EAN-UCC GLN

07 SAN

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Publisher> <PublisherIdentifier>
<IDTypeName>

 

Optional within <PublisherIdentifier>

Not repeatable

 

The name of the identification scheme from which the <IDValue> is taken, used only when <PublisherIDType> is “01” (proprietary).

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Publisher> <PublisherIdentifier>
<IDValue>

 

Mandatory within <PublisherIdentifier>

Not repeatable

 

An identifier of the type specified in <PublisherIDType>.

 

 

 

<ONIXSerialsOnlineHoldingsAtoZ> <HoldingsList> <OnlineService> <Publisher>
<PublisherName> Optional within <Publisher>

Not repeatable

 

<Publisher> must contain either <PublisherIdentifier> or <PublisherName> or both.

 

The name of the publisher; that is, the vendor of the online service.

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Publisher>
<PublisherName>

 

Optional within <Publisher>

Not repeatable

 

The text name of the publisher of the serial version.

 

<Publisher> must contain either <PublisherIdentifier> or <PublisherName> or both.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService>
<Website>

 

Optional within <OnlineService>

Repeatable if there is more than one website that can be used to access a content hosting system, other than mirror sites

 

Details of a website that is used to access a content hosting system.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Website>
<WebsiteRole>

 

Mandatory within <Website>

Not repeatable

 

The role of a website.

 

Permissible code values:

00 Unspecified, see website description

03 Online hosting service home page

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Website>
<WebsiteDescription>

 

Optional within <Website>

Not repeatable

 

A free-text description of the nature or function of a website.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Website>
<MirrorSite>

 

Optional within <Website>

Repeatable for multiple mirror sites

 

Details of a site that mirrors a <Website>.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <OnlineService> <Website> <MirrorSite>
<WebsiteDescription>

 

Optional within <Website>

Not repeatable

 

A free-text description of the nature or function of a website.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList>
<NoOnlineService>

Optional within <HoldingsList>

Not repeatable

 

An empty element indicating that the serial versions in the Holdings List are available independently of a hosted collection.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList>
<HoldingsRecord>

 

Mandatory within <HoldingsList>

Repeatable

 

Details of the holdings for one serial version. There will be one occurrence for each distinct serial version in the Holdings List.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord>
<NotificationType>

 

Mandatory within <HoldingsRecord>

Not repeatable

 

Indicates whether this <HoldingsRecord> is a new record, a deletion, or an update.

 

If <CompleteFile/> is present in the message header (that is, this is a complete replacement file), then <NotificationType> will always be “00”.

 

If <DeltaFile/> is present in the message header (that is, this message is an update file), then <NotificationType> will be either “05” to indicate that the holdings record is to be deleted; “06” to indicate that this is a new holdings record, or “07” to indicate that this holdings record is a replacement of a previously transmitted subscription holdings record.

 

Note that each holdings record must itself be complete, since there is no provision for updating at the element level.

 

 

 

Permissible code values:

00 Unspecified

05 Delete

06 New

07 Update (complete replacement)

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord>
<SerialVersion>

 

Mandatory with <HoldingsRecord>

Not repeatable

 

Identification and description of the serial version whose holdings are represented in the <HoldingsRecord>. There will be at one and only one serial version in each holdings record.

 

It is important to understand that, in ONIX, a <SerialVersion> relates to a particular manifestation of a serial work, for example the online version of a named journal. Relative to this example, the printed version of the same journal would correspond to a different <SerialVersion>, as would another online version containing only the text of the journal articles but not the associated images. A print-plus-online combination for the same journal could well be a subscription product; but it is not itself a <Serial Version> though it may contain two or more serial versions.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion>
<SerialVersionIdentifier>

 

Mandatory within <SerialVersion>

Repeatable for identifiers with different IDTypes

 

A coded identifier of a serial version.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <SerialVersionIdentifier>
<SerialVersionIDType>

 

Mandatory within <SerialVersionIdentifier>

Not repeatable

 

A code indicating the scheme or standard from which the serial version identifier is taken. If <SerialVersionIDType> is “01” (proprietary), then the name of the scheme should appear in <IDTypeName>.

 

ISSN (IDType = “07) should be used only if it identifies a serial version uniquely. That is, ISSN should not be used if the same ISSN has been assigned to all manifestations of a work (e.g. to both the print and online versions).

 

ISSNs are always sent in their unhyphenated form in ONIX.

 

 

 

Permissible code values:

01 Proprietary

06 DOI

07 ISSN

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <SerialVersionIdentifier>
<IDTypeName>

 

Optional within <SerialVersionIdentifier>

Not repeatable

 

The name of the identification scheme from which the <IDValue> is taken, used only when <SerialVersionIdentifier> is “01” (proprietary).

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <SerialVersionIdentifier>
<IDValue>

 

Mandatory within <SerialVersionIdentifier>

Not repeatable

 

An identifier of the type specified in <SerialVersionIDType>.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion>
<Title>

 

Optional within <SerialVersion>

Repeatable for different types of the title

Has “language” attribute.

 

The title of the work of which the serial version is a manifestation.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <Title>
<TitleType>

 

Optional within <Title>

Not repeatable.

 

A code showing the type of title. If omitted, the title type defaults to “00” (undefined).

 

 

 

Permissible code values:

00 Undefined

01 Distinctive title(book); cover title (serial)

02 ISSN key title of serial

03 Title in original language

04 Title acronym

05 Abbreviated title

06 Title in other language

09 Sender's catalog title

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <Title>
<TitleText>

 

Mandatory within <Title>

Not repeatable.

Has “language” attribute.

 

The text of the title, excluding subtitle. If multiple types of title are sent, the entire <Title> composite is repeated.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <Title>
<Subtitle>

 

Optional within <Title>

Not repeatable.

Has “Language” attribute.

 

The text of the subtitle, if there is one.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion>
<Publisher>

 

Optional within <SerialVersion>

Repeatable for co-publishers or different Publisher Roles.

 

Publisher of the intellectual content of the work; repeatable if there are co-publishers or if there are different Publisher Roles.

 

Must contain either <PublisherIdentifier> or <PublisherName>.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <Publisher>
<PublishingRole>

 

 

<ONIXSerialsOnlineHoldingsAtoZ> is the first and mandatory element in the opening “wrapper” of the message, specifying an ONIX SOH format applied to a “flat” AtoZ holdings list. The element carries a version number as an XML attribute “version”. This release of the User Guide describes version number 1.0, which is expressed as:

 

<ONIXSerialsOnlineHoldingsAtoZ version=”1.0”>

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <Publisher>
<PublisherIdentifier>

 

Optional within <Publisher>

Repeatable if there are multiple identifiers with different PublisherIDTypes.

 

Identification of a publisher using a value from a standard or proprietary identification scheme.

 

<Publisher> must contain either <PublisherIdentifier> or <PublisherName> or both.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <Publisher> <PublisherIdentifier>
<PublisherIDType>

 

Mandatory within <PublisherIdentifier>

Not repeatable

 

A code indicating the scheme or standard from which the publisher identifier is taken. If <PublisherIDType> is “01” (proprietary), then the name of the scheme should appear in <IDTypeName>.

 

 

 

Permissible code values:

01 Proprietary

06 EAN-UCC GLN

07 SAN

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <Publisher> <PublisherIdentifier>
<IDTypeName>

 

Optional within <PublisherIdentifier>

Not repeatable

 

The name of the identification scheme from which the <IDValue> is taken, used only when <PublisherIDType> is “01” (proprietary).

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <Publisher> <PublisherIdentifier>
<IDValue>

 

Mandatory within <PublisherIdentifier>

Not repeatable

 

An identifier of the type specified in <PublisherIDType>.

 

 

 

<ONIXSerialsOnlineHoldingsAtoZ> <HoldingsList> <OnlineService> <Publisher>
<PublisherName> Optional within <Publisher>

Not repeatable

 

<Publisher> must contain either <PublisherIdentifier> or <PublisherName> or both.

 

The name of the publisher; that is, the vendor of the online service.

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <Publisher>
<PublisherName>

 

Optional within <Publisher>

Not repeatable

 

The text name of the publisher of the serial version.

 

<Publisher> must contain either <PublisherIdentifier> or <PublisherName> or both.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion>
<OnlinePackage>

Mandatory within <SerialVersion>

Not repeatable

 

Details of online content for the specified serial version from the content hosting system specified in <OnlineService> at the beginning of <HoldingsList>, or, if <NoOnlineService/> is present, then <OnlineService> contains details of a serial version available independently of a hosted collection.

 

 

Example:

The Website composite gives the URL of the journal contents page for this serial version as delivered in the hosted collection identified at the beginning of the <HoldingsList>. Examples of <PackageDetail> and <Embargo> appear elsewhere in this document.

 

<OnlinePackage>

     <Website>

          <WebsiteRole>05</WebsiteRole>     05 = Online journal 'available contents' page

          <WebsiteLink>http://muse.jhu.edu/journals/asian_music/</WebsiteLink>

          <MirrorSite>

               <WebsiteDescription>Australian mirror site<WebsiteDescription>

               <WebsiteLink>http://muse.uq.edu.au/journals/asian_music/</WebsiteLink>

          </MirrorSite>

     </Website>

     <PackageDetail>

          [<PackageDetail> information, if any, would appear here.]

     </PackageDetail>

     <Embargo>

          [<Embargo> information, if any, would appear here.]

     </Embargo>

     <LicenseTermsDescription>

          [<LicenseTermsDescription> information, if any, would appear here.]

     </LicenseTermsDescription>

</OnlinePackage>

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage>
<Website>

 

Optional within <OnlinePackage>

Repeatable if there is more than one website that can be used to access a serial version from a particular content hosting system or online publisher, other than mirror sites.

 

Details of a website that can be used to access a serial version from a particular content hosting system or online publisher; that is, the serial’s “’available contents’ page.”

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <Website>
<WebsiteRole>

 

Mandatory within <Website>

Not repeatable

 

The role of a website. In this context, always “05” (Online journal 'available contents' page).

 

In some cases, the 'available contents' page may be identical to the serial’s home page, but it should be identified here as the 'available contents' page.

 

Permissible code values:

05 Online journal 'available contents' page

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <Website>
<WebsiteDescription>

 

Optional within <Website>

Not repeatable

 

A free-text description of the nature or function of a website.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <Website>
<MirrorSite>

 

Optional within <Website>

Repeatable for multiple mirror sites

 

Details of a site that mirrors a <Website>.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <Website> <MirrorSite>
<WebsiteDescription>

 

Optional within <Website>

Not repeatable

 

A free-text description of the nature or function of a website.

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage>
<PackageDetail>

 

Optional in <OnlinePackage>

Repeatable

 

Details of the coverage and completeness of the full online content accessible for a serial version through the specified content hosting system. Repeatable if the package includes ranges with different levels of completeness and/or online formats. Either <PackageDetail> or <NoPackageDetail> must appear in <OnlinePackage>.

 

Must include <JournalIssue>.

 

 

 

Example: In this example, the online coverage for this serial version starts with vol. 1, issue 1, and extends to the present, therefore there is no <JournalIssue> for the end of the range.

Content is delivered as both HTML and PDF, therefore <EpubFormat> is repeated.

 

<PackageDetail>

     <JournalIssue>

          <JournalIssueRole>04</JournalIssueRole>          04 = “Start of range”

          <JournalVolumeNumber>1</JournalVolumeNumber>

          <JournalIssueNumber>1</JournalIssueNumber>

          <JournalIssueDate>

               <Calendar>00</Calendar>                    00 = “Gregorian”

               <DateFormat>01</DateFormat>          01 = “YYYYMM”

               <Date>199802</Date>

          </JournalIssueDate>

     </JournalIssue>

     <IssueCompleteness>02</IssueCompleteness>          02 = “all articles”

     <ArticleCompleteness>01</ArticleCompleteness>     01 = “complete articles”

     <OriginalContent>02</OriginalContent>          02= Includes original content not in print version

     <ContentDescription>Optional descriptive note</ContentDescription>

     <EpubFormat>01</EpubFormat>                    01 = “HTML”

     <EpubFormat>02</EpubFormat>                    02 = “PDF”

</PackageDetail>

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <PackageDetail>
<JournalIssue>

 

 

Required within <PackageDetail>

Repeatable

 

A range of issues that are accessible, specified in terms of the enumeration and/or chronology of the start and end of the range.

 

There will be either one or two occurrences, one for the beginning and one (optionally) for the end of the range.

 

At least one of <JournalVolumeNumber> or <JournalIssueNumber> or <JournalIssueDate> or <JournalIssueDesignation> must appear in <JournalIssue>.

 

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <PackageDetail> <JournalIssue>
<JournalIssueRole>

 

Mandatory within <JournalIssue>

Not repeatable

 

A code indicating whether this occurrence of <JournalIssue> specifies the beginning or the end of a range of issues.

 

Three values are permitted:

04     From     (this <JournalIssue> composite represents the start of a range of issues)

05     To     (this <JournalIssue> composite represents the end of a range of issues)

06     To, and expected to continue (this <JournalIssue> composite represents the latest issue available, but the publication/subscription is ongoing, and the next issue is expected)

 

If the coverage is open (either to the present or to the present minus an embargo period), then only one occurrence of <JournalIssue> will appear, with <JournalIssueRole> = 04.

 

If the coverage is closed (the journal is not accessible after a certain issue), then a second <JournalIssue> composite will be included, with <JournalIssueRole> = 05.

 

Senders may indicate the latest issue available for an ongoing publication, by using a second <JournalIssue> composite with <JournalIssueRole> = 06.

 

05 and 06 should not co-exist in the same <PackageDetail> composite.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <PackageDetail> <JournalIssue>
<JournalVolumeNumber>

 

Optional

Not repeatable

 

Volume number of the beginning or end of the range.

 

At least one of <JournalVolumeNumber> or <JournalIssueNumber> or <JournalIssueDate> or <JournalIssueDesignation> must appear in <JournalIssue>.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <PackageDetail> <JournalIssue>
<JournalIssueNumber>

 

Optional

Not repeatable

 

Issue number of the beginning or end of the range.

 

At least one of <JournalVolumeNumber> or <JournalIssueNumber> or <JournalIssueDate> or <JournalIssueDesignation> must appear in <JournalIssue>.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <PackageDetail> <JournalIssue>
<JournalIssueDesignation>

 

Optional

Not repeatable

 

Free-text description of the enumeration of the beginning or end of the range.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <PackageDetail> <JournalIssue>
<JournalIssueDate>

 

Optional

Not repeatable

 

Cover date of the beginning or end of the range of issues.

 

At least one of <JournalVolumeNumber> or <JournalIssueNumber> or <JournalIssueDate> or <JournalIssueDesignation> must appear in <JournalIssue>.

 

 

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <PackageDetail> <JournalIssue> <JournalIssueDate>
<DateFormat>

 

Mandatory

Not repeatable

 

A code indicating the format in which the date is given. Codes 06-11 are used in the case where the cover date of an issue is a range of dates.

 

 

 

Permissible code values:

00 YYYYMMDD

01 YYYYMM

02 YYYYWW

03 YYYYQ

04 YYYYS

05 YYYY

06 YYYYMMDDYYYYMMDD

07 YYYYMMYYYYMM

08 YYYYWWYYYYWW

09 YYYYQYYYYQ

10 YYYYSYYYYS

11 YYYYYYYY

12 Text string

 

<ONIXSerialsOnlineHoldingsByHost> <HoldingsList> <HoldingsRecord> <SerialVersion> <OnlinePackage> <PackageDetail> <JournalIssue> <JournalIssueDate>
<Date>

 

Mandatory within <JournalIssueDate>

Not repeatable