Mandatory
Optional
|
ONIX code list |
Values or Format |
Description |
|
<ONIXMessage release="3.0"> |
|
|
|
|
<Header> |
|
|
|
|
<Sender> |
|
|
|
|
<SenderIdentifier> |
|
|
|
|
<SenderIDType> |
Optional |
44 |
6 | 06 : GLN |
<IDTypeName> |
Optional |
|
GLN | « GLN » |
<IDValue> |
Optional |
|
|
|
</SenderIdentifier> |
|
|
|
|
<SenderName> |
Optional |
|
|
|
<ContactName> |
|
|
|
|
<EmailAddress> |
|
|
|
|
</Sender> |
|
|
|
|
<MessageNumber> |
Optional |
|
1 |
|
<SentDateTime> |
Optional |
|
Date | Ex. 20110309T022935Z |
<DefaultLanguageOfText> |
Optional |
|
fre |
|
<DefaultCurrencyCode> |
Optional |
96 |
3 letter code |
ISO 4217 currency codes |
</Header> |
|
|
|
|
<Product> |
|
|
|
|
<RecordReference> |
Mandatory |
1 |
Text | Record identifier. Format : Platform prefix + publication's internal identifier – format nature. Ex : « EDGT5513-epub » |
<NotificationType> |
Mandatory |
1 |
03 ; 04 ; 05 |
03 : Notification confirmed from book-in-hand 04 : Update 05 : Delete |
<ProductIdentifier> |
Repeat |
|
|
|
<ProductIDType> |
Mandatory |
5 |
01 ; 02 ; 03 ; 15 |
01 : Custom 02 : ISBN 10 03 : EAN15 : ISBN 13 |
<IDValue> |
Mandatory |
|
Number | Identifier's value (ISBN) |
</ProductIdentifier> |
|
|
|
|
<DescriptiveDetail> |
Mandatory |
|
|
|
<ProductComposition> |
Mandatory |
2 |
0 | 00 : Single-item retail product |
<ProductForm> |
Mandatory |
150 |
EA | EA : Digital (delivered electronically) |
<ProductFormDetail> |
Optional |
175 |
E101 ; E107 ; E127 |
E101 : ePub E107: PDF E127: Mobi E200 (with E101) - Reflowable E201 (with E101) – Fixed Layout |
<EpubTechnicalProtection> |
Optional |
144 |
00 ; 02 ; 03 |
00 : None 02 : Watermark 03 : Adobe DRM 06 : Readium LCP DRM |
<EpubUsageConstraint> |
Repeat |
|
|
|
<EpubUsageType> |
Mandatory |
145 |
02 ; 03 ; 04 |
02 : Print 03 : Copy / paste 04 : Share |
<EpubUsageStatus> |
Mandatory |
146 |
01; 02; 03 |
01 : Permitted unlimited 02 : Permitted subject to limit 03 : Prohibited |
<EpubUsageLimit> |
Repeat |
|
|
|
<Quantity> |
Optional |
|
Number | Maximum permitted quantity, ex : 6 |
<EpubUsageUnit> |
Optional |
147 |
06 ; 09 |
06 : Devices ( Maximum number of devices in ‘share group’.) 09: days |
</EpubUsageLimit> |
|
|
|
|
</EpubUsageConstraint> |
|
|
|
|
A collection |
* See also CollateralDetail / TextContent / TextType 17 and WebSite / Web | |||
<Collection> * |
Optional | |||
<CollectionType> | Mandatory if collection |
148 | 11 |
11 : Collection éditoriale |
<TitleDetail> | Mandatory if collection | |||
<TitleType> | Mandatory if collection | 15 | 01 | 01 : Title on item |
<TitleElement> | Mandatory if collection | |||
<TitleElementLevel> | Mandatory if collection | 149 | 02 | 01 : Collection level |
<TitleText> | Mandatory if collection | Text | Collection's title, text format |
|
</TitleElement> | ||||
</TitleDetail> | ||||
</Collection> | ||||
A serie |
* See also CollateralDetail / TextContent / TextType 17 and WebSite / Web | |||
<Collection> * |
Optional | |||
<CollectionType> | Mandatory if series |
148 | 10 |
10 : Publisher collection |
<CollectionIdentifier> | Optional | |||
<CollectionIDType> | 13 | 01 | 01 : Proprietary |
|
<IDValue> | User internal identifier for the serie |
|||
</CollectionIdentifier> | ||||
<TitleDetail> |
Mandatory if series | |||
<TitleType> | Mandatory if series | 15 | 01 | 01 : Title on item |
<TitleElement> | Mandatory if series | |||
<TitleElementLevel> | Mandatory if series | 149 | 02 | 02 : Collection level |
<TitleText> | The title of the series | |||
</TitleElement> | Optional | |||
<TitleElement> | 149 | 01 | 01: Name of an individual product in the series | |
<TitleElementLevel> | ||||
<PartNumber> | Sequential part, as it should be display on stores sites : ex "Volume 2", "Vol. 23, No. 2" | |||
</TitleElement> | ||||
</TitleDetail> | ||||
</Collection> | ||||
A collection AND a serie |
|
|||
<Collection> | Optional | * See also CollateralDetail / TextContent / TextType 17 and WebSite / Web | ||
<CollectionType> | 148 | 10 | 10 : Publisher collection | |
<CollectionIdentifier> |
||||
<CollectionIDType> |
149 | 02 |
02 : Collection level | |
<IDValue> | Text | Identifier of the series, for example, an ISSN in the case of a periodical. |
||
<CollectionSequence> | ||||
<CollectionSequenceType> | 197 | 03 |
03 : Series title if there's a Collection AND Series | |
<CollectionSequenceNumber> | Number | Publication order. Numeric part only, example "2", "12", etc. | ||
</CollectionSequence> | ||||
</CollectionIdentifier> | ||||
<TitleDetail> | ||||
<TitleType> | 15 | 01 |
01 : Title on item | |
<TitleElement> | ||||
<TitleElementLevel> | 149 | 02 |
02 : Collection level | |
<TitleText> | Text | Title of the collection, text format. |
||
</TitleElement> | ||||
<TitleElementLevel> | 149 | 01 |
01 : Product | |
<TitleText> | Text | Sequential part, as it should be display on stores sites : ex "Volume 2", "Vol. 23, No. 2" | ||
</TitleElement> | ||||
</TitleDetail> | ||||
</Collection> | ||||
</Collection> |
|
|
|
|
<TitleType> |
Mandatory |
15 |
1 | 01 : Distinctive title (book); Cover title (serial); Title on item (serial content item or reviewed resource) |
<TitleElement> |
|
|
|
|
<TitleElementLevel> |
Mandatory |
149 |
1 | 01 : Product |
<TitleText> |
Mandatory |
|
Text | Title of the publication |
<TitlePrefix> |
Optional |
|
Text | Title's prefix |
<TitleWithoutPrefix> |
Optional |
|
Text | Title without prefix – Title for sorting |
<SubTitle> |
|
|
|
|
</TitleElement> |
|
|
|
|
</TitleDetail> |
|
|
|
|
<Contributor> |
Repeat |
|
|
|
<SequenceNumber> |
Mandatory |
|
Number | The sequence number increments while the contributor's importance decreases |
<ContributorRole> |
Mandatory |
17 |
|
Contributor's role. A01: "author" A02: "with" A03: "screenplay_writer" A04: "libretto_writer" A05: "lyrics_author" A06: "composer" A07: "artist" A08: "photographer" A09: "created_by" A10: "from_an_idea_by" A11: "designed_by" A12: "illustrated_by" A13: "photographs_by" A14: "text_author" A15: "preface_author" A16: "prologue_author" A17: "summary_author" A18: "supplement_author" A19: "afterword_author" A20: "notes_author" A21: "commentaries_author" A22: "epilogue_author" A23: "foreword_author" A24: "introduction_author" A25: "footnotes_author" A26: "memoir_author" A27: "experiments_author" A29: "introduction_and_notes_author" A30: "software_writer" A31: "book_and_lyrics_author" A32: "contributions_author" A33: "appendix_author" A34: "index_compiler" A35: "drawings_by" A36: "cover_design_or_artwork_by" A37: "preliminary_work_by" A38: "original_author" A39: "maps_by" A40: "inked_or_colored_by" A41: "pop_ups_by" A42: "continued_by" A43: "interviewer" A44: "interviewee" A99: "other_primary_creator" B01: "edited_by" B02: "revised_by" B03: "retold_by" B04: "abridged_by" B05: "adapted_by" B06: "translated_by" B07: "as_told_by" B08: "translated_with_commentary_by" B09: "series_edited_by" B10: "edited_and_translated_by" B11: "editor_in_chief" B12: "guest_editor" B13: "volume_editor" B14: "editorial_board_member" B15: "editorial_coordination_by" B16: "managing_editor" B17: "founded_by" B18: "prepared_for_publication_by" B19: "associate_editor" B20: "consultant_editor" B21: "general_editor" B22: "dramatized_by" B23: "general_rapporteur" B24: "literary_editor" B25: "music_arranged_by" B26: "technical_editor" B99: "other_adaptation_by" C01: "compiled_by" C02: "selected_by" C99: "other_compilation_by" D01: "producer" D02: "director" D03: "conductor" D99: "other_direction_by" E01: "actor" E02: "dancer" E03: "narrator" E04: "commentator" E05: "vocal_soloist" E06: "instrumental_soloist" E07: "read_by" E08: "performed_by_orchestra_band_ensemble" E09: "speaker" E99: "performed_by" F01: "filmed_photographed_by" F99: "other_recording_by" Z01: "assisted_by" Z98: "various_roles" Z99: "other" |
<PersonName> |
Mandatory |
|
Text | Contributor's full name, ex : René J. Blanchet |
<PersonNameInverted> |
Optional |
|
Text | Contributor's full name, inverted, ex : Blanchet, René J. |
<NamesBeforeKey> |
Mandatory |
|
Text | Person name part 2. First name and initials. Ex : René J. |
<KeyNames> |
Mandatory |
|
Text | Person name part 4. Last name. Ex : Blanchet |
<BiographicalNote> |
|
|
Text | A biographical note about a contributor to the product. |
<Website> |
|
|
|
|
<WebsiteRole> |
Optional |
73 |
01 ; |
01 : Contributor's corporate website 02 : Publisher’s website for a specified work 14 : Publisher’s website relating to series of works |
<WebsiteLink> |
Optional |
|
URL | URL |
<Website> |
|
|
|
|
<ContributorPlace> |
|
|
|
|
<ContributorPlaceRelator> |
|
151 |
|
04 Currently resides in 08 Citizen of Or nationality. For use with country codes only. |
<CountryCode> |
|
|
|
2 letters country code (Format ISO 3166-1 : "fr", "us", "ca") |
</ContributorPlace> |
|
|
|
|
</Contributor> |
|
|
|
|
<NoEdition/> |
Optional |
|
|
If the publication is the original text. |
<Language> |
Repeat |
|
|
|
<LanguageRole> |
Optional |
22 |
01 ; 02 |
01 : Language of text 02 : Original language of a translated text. |
<LanguageCode> |
Optional |
74 |
Code de langue ISO 639-2/B. | Ex : fre ; ita; eng |
</Language> |
|
|
|
|
<Extent> |
Repeat |
|
|
|
<ExtentType> |
Mandatory |
23 |
00; 03; 08; 22 |
00, 08 : Page count 03 : Front matter page count (Roman-numbered) pages 22 : File size |
<ExtentValue> |
Mandatory |
|
Number | Value |
<ExtentUnit> |
Optional |
24 |
19 |
03 : Pages 19 : Megabytes (if ExtentType = 22); |
</Extent> |
|
|
|
|
<Subject> |
Repeat |
|
|
Classifications |
<MainSubject/> |
Repeat |
|
|
To be used only when classification is primary. |
<SubjectSchemeIdentifier> |
Mandatory |
27 |
01 ; 10 ; 24 ; 28 ; 29 |
01 : Dewey 10 : BISAC 20 : Keywords 24 : Custom 28 : Electre 29 : CLIL |
<SubjectSchemeName> |
|
|
|
|
<SubjectCode> |
Optional |
|
|
Code value |
<SubjectHeadingText> |
Optional |
|
|
Subject heading text - according to SubjectSchemeIdentifier |
</Subject> |
|
|
|
|
<Audience> |
Optional |
|
|
|
<AudienceCodeType> |
Optional |
29 |
01;02;06; |
01: Onix Codes 02: Proprietary 06: BTLF audience Code Proprietary when apple-interest-age-years Match with AudienceCodeTypeName |
<AudienceCodeValue> |
Optional |
|
|
acceptable ranges are 01 : General/Trade 0002 : 0 to 2 years old 0305 : 3 to 5 years old 0608 : 6 to 8 years old 0912 : 9 to 12 years old 1399 : 13+ |
</Audience> |
|
|
|
|
<AudienceRange> | Optional | |||
<AudienceRangeQualifier> | Optional | 17 | Qualifier 17 : Ages |
|
<AudienceRangePrecision> | Optional | 03 | 03 : From (can be used alone) |
|
<AudienceRangeValue> | Optional | Minimum recommended age |
||
<AudienceRangePrecision> | Optional | 04 | 04 : To |
|
<AudienceRangeValue> | Optional | Maximum recommended age |
||
</Audience> | |
|||
<Prize> |
|
|
|
|
<PrizeName> |
Optional |
|
Text | Nom du prix littéraire |
<PrizeYear> |
Optional |
|
Year | Exemple : 2014 |
<PrizeCountry> |
Optional |
|
|
Code de pays, en format ISO 3166-1 |
<PrizeCode> |
Optional |
|
01; 02; 03; 04; 05; 06; |
01: Winner 02: Runner-up 03: Commended 04: Short-listed 05: Long-listed 06: Joint winner |
</Prize> |
|
|
|
|
</DescriptiveDetail> |
|
|
|
|
<CollateralDetail> |
|
|
|
|
<TextContent> |
Repeat |
|
|
|
<TextType> |
Mandatory |
153 |
02 ; 03 ; 04; 05 ; 06; 09; 10; 12; 14; 17; |
Text type. 02 : Comments 03 : Summary 04 : Table of contents 05 : Presentation 06 : Review quote 09 : Endorsement 10 : Promotional headline 12 : Biographical note 14 : Excerpt 17 : Serie Description (see Collection) |
<ContentAudience> |
Mandatory |
154 |
0 |
Audience. 00 : Unrestricted |
<Text> |
Mandatory |
|
Text | Text value. |
</TextContent> |
|
|
|
|
<SupportingResource> |
Repeat |
|
|
|
<ResourceContentType> |
Mandatory |
158 |
01 ; 02 ; 03 ; 04 ; 11 ; 15 ; 16 ; 17 ; 20 ; 21 ; 24 ; 26 |
01 : Front cover 02 : Back cover 03 : Cover other 04 : Contributor picture 11 : Contributor interview 15 : Sample content 16 : Flipbook URL 17 : Review 20 : Teacher guide 21 : Feature Article 24 : Press release 26 : Trailer |
<ContentAudience> |
Repeat |
154 |
0 |
Audience. 00 : Unrestricted |
<ResourceMode> |
Mandatory |
159 |
01 ; 02 ; 03 ; 04 ; 05 ; 06 |
01 : Application 02 : Audio 03 : Image 04 : Text 05 : Video 06 : Multi-mode Supported file extensions : 02 : 'mp3', 'wav', 'wma', 'mp4' 03 : 'png', 'bmp', 'jpg', 'jpeg', 'gif', 'tif' 04 : 'doc', 'docx', 'xls', 'xlsx', 'odp', 'ods', 'odt', 'epub', 'pdf', 'txt', 'rtf' 05 : 'flv', 'mpeg', 'mpg', 'avi', 'mov' |
<ResourceFeature> |
Optional |
|
|
|
<ResourceFeatureType |
Mandatory |
160 |
2 | Explanatory caption that may accompany a resource (eg use to identify an author in a photograph) Important : To link an author's photograph, you must use 02 here with the exact name of the contributor. |
<FeatureValue> |
Optional |
|
Text | Media title |
<FeatureNote> |
Optional |
|
Text | Media description |
</ResourceFeature> |
|
|
|
|
<ResourceVersion> |
|
|
|
|
<ResourceForm> |
Mandatory |
161 |
01 ; 02 |
01 : Linkable ressource 02 : Downloadable file |
<ResourceVersionFeature> |
|
|
|
|
<ResourceVersionFeatureType> |
|
162 |
01 ; 02 ; 03 ; 04 |
01 : File format 02 : Image height in pixels 03 : Image width in pixels 04 : Filename |
<FeatureValue> |
Optional |
|
Number | Value |
</ResourceVersionFeature> |
|
|
|
|
<ResourceLink> |
Mandatory |
|
URL |
Ressource URL or http://.../large.jpg http://.../small.jpg |
<ContentDate> |
Optional |
|
|
|
<ContentDateRole> |
Mandatory |
|
17 | Last update date of the front cover media. |
<DateFormat> |
Mandatory |
|
00; | 00 : YYYYMMDD Most ONIX's date formats are supported. This is a suggestion on a simple date format. |
<Date> |
Mandatory |
|
Date | Ex.: 20120501 |
</ContentDate> |
Mandatory |
|
|
|
</ResourceVersion> |
|
|
|
|
</SupportingResource> |
|
|
|
|
</CollateralDetail> |
|
|
|
|
<PublishingDetail> |
|
|
|
|
<Imprint> |
|
|
||
<ImprintName> | Optional | Text | Marque éditoriale | |
</Imprint> | ||||
<Publisher> |
|
|
|
|
<PublishingRole> |
Mandatory |
45 |
01 ; | 01 : Publisher |
<PublisherIdentifier> |
|
|
|
|
<PublisherIDType> |
Mandatory |
44 |
06 ; | 06 : GLN |
<IDTypeName> |
Mandatory |
|
GLN | « GLN » |
<IDValue> |
Mandatory |
|
Number | Publisher's internal ID. |
</PublisherIdentifier> |
Mandatory |
|
|
|
<PublisherName> |
|
|
Text | Publisher name |
<Website> |
Repeat |
|
|
|
<WebSiteRole> |
Mandatory |
73 |
01 ; 02; 14 |
01 : Publisher's corporate website 02 : Publisher's website for a specified work. 14 : Collection's web site (see Collection |
<WebSiteLink> |
Mandatory |
|
URL | URL |
</Website> |
|
|
|
|
</Publisher> |
|
|
|
|
<PublishingStatus> |
Mandatory |
64 |
04 ; 08 ; |
04 : Active 08 : Inactive (Paper format is always Inactive) |
<PublishingDate> |
|
|
|
|
<PublishingDateRole> |
Optional |
|
01; 09; 19 |
01 : Nominal date of publication 09 : Public announcement date - Date when a new product may be announced to the general public. 19 : Publication date of print counterpart |
<DateFormat> |
|
|
00; 14 | 00 : YYYYMMDD 14 : YYYYMMDDThhmmss. Alternatively, the time may be suffixed with an optional ‘Z’ for UTC times, or with ‘+’ or ‘-’ and an hhmm timezone offset from UTC. (Ex. : 20120530T131243-0400) |
<Date> |
|
|
|
|
</PublishingDate> |
|
|
|
|
<SalesRights> |
Mandatory |
|
|
|
<SalesRightsType> |
Mandatory |
46 |
01 ; 03 ; |
01 : For sale with exclusive rights in the specified country/ies 03 : Not for sale in the specified country/ies. |
<Territory> |
|
|
|
|
<CountriesIncluded> |
Mandatory |
91 |
Codes de pays ISO 3166-1 Alpha-2 | Countries included in the territory. Ex : CA FR |
<RegionsIncluded> | WORLD | WORLD : All available countries in the platform. | ||
</Territory> |
|
|
|
|
</SalesRights> |
|
|
|
|
<SalesRestriction> |
|
|
|
|
<SalesRestrictionType> |
Optional |
71 |
09; | Tag absent if book can be sold for lending, or tag present with value 09 if book can't be sold for lending. |
</SalesRestriction> |
|
|
|
|
</PublishingDetail> |
|
|
|
|
<RelatedMaterial> |
|
|
|
|
<RelatedProduct> |
Repeat |
|
|
|
<ProductRelationCode> |
Mandatory |
51 |
00; 01; 02; 06; 07; 08; 11; 12; 13; 22; 23; 28; 29; 30; 31; |
00 : Unspecified 01 : Includes 02 : Is part of 06 : Alternative format. 07 : Has ancillary product 08 : Is ancillary to 11 : Is remainder of 12 : Publisher's suggested alternative 13 : Epublication based on (print product). 22 : Product by same author 23 : Similar product 28 : Enhanced version 29 : Basic version available as 30 : Product in same collection 31 : Library product |
<ProductIdentifier> |
|
|
|
|
<ProductIDType> |
Mandatory |
5 |
01 ; 02 ; 03 ; 15 |
01 : Custom 02 : ISBN 10 03 : EAN 15 : ISBN 13 |
<IDValue> |
Mandatory |
|
Number | Identifier's value |
</ProductIdentifier> |
|
|
|
|
</RelatedProduct> |
|
|
|
|
</RelatedMaterial> |
|
|
|
|
<ProductSupply> |
|
|
|
|
<Market> |
||||
<Territory> |
||||
<CountriesIncluded> |
Codes de pays ISO 3166-1 Alpha-2 | Countries included in the territory. Ex : CA FR | ||
</Territory> | ||||
</Market> | ||||
<SupplyDetail> |
|
|
|
|
<Supplier> |
|
|
|
|
<SupplierRole |
|
93 |
01 ; 06 |
01 : Publisher to retailers 06 : Publisher's distributor to retailers |
<SupplierIdentifier> |
|
|
|
|
<SupplierIDType> |
Mandatory |
SupplierIDType |
06 ; | 06 : GLN |
<IDValue> |
Mandatory |
IDValue |
Number | Publisher / distributor internal id |
</SupplierIdentifier> |
|
|
|
|
<SupplierName> |
|
|
Text | Publisher name |
<Website> |
|
|
|
|
<WebSiteRole> |
Mandatory |
73 |
|
01 : Publisher’s corporate website |
<WebSiteLink> |
Mandatory |
|
|
URL |
</Website> |
|
|
|
|
</Supplier> |
|
|
|
|
<ProductAvailability> |
Mandatory |
65 |
20; 40 | 20 : Available40 : Not Available |
<SupplyDate> |
|
|
|
|
<SupplyDateRole> |
|
166 |
8 | 08 : Expected availability date (Available at date) |
<DateFormat> |
|
55 |
0 | 00 : YYYYMMDD |
<Date> |
|
|
Date. ISO 8601 | Date |
</SupplyDate> |
|
|
|
|
<Price> |
Repeat |
|
|
|
<PriceType> |
Mandatory |
58 |
03 ; 04 |
03 : Fixed retail price excluding tax 04 : Fixed retail price including tax |
<PriceQualifier> |
Mandatory |
59 |
05 ; | 05 : Price for individual sale |
<PriceStatus> |
Mandatory |
61 |
02 ; | 02 : Firm |
<PriceAmount> |
Mandatory |
|
Montant | Ex : 20,85 |
<CurrencyCode> |
Mandatory |
96 |
Code devise. ISO 4217 | Ex : EUR |
<Territory> |
|
|
|
|
<CountriesIncluded> |
Mandatory |
|
Code pays 2 caractères ISO 3166-1 Alpha-2 | Country where the price is available. Could list many countries separated by a space Ex : CountriesIncludedUS CA/CountriesIncluded |
</Territory> |
|
|
|
|
<PriceDate> |
|
|
|
|
<PriceDateRole> |
Mandatory |
14 | 14 : From date | |
<DateFormat> |
Mandatory |
|
0 | 00 : YYYYMMDD |
<Date> |
Mandatory |
Date. ISO 8601 | Date is provided in ISO 8601 Basic format. Although the DateFormat is not in this particular format, it is the closer to this standard. Ex. : « 2010-05-27T11:44:24+01:00 » | |
</PriceDate> |
|
|
|
|
</Price> |
|
|
|
|
</SupplyDetail> |
|
|
|
|
</ProductSupply> |
|
|
|
|
</Product> |
|
|
|
|
</ONIXMessage> |
|
|
|
|