Skip to main content

WAI Extension: Release Messages

Mirrored from the canonical text at commit 498e6b88 ().

Status: Draft. Registers no capability and no record. A release reaches a service as a release notification of DDEX’s Electronic Release Notification standard, version 4.3.2 (ERN 4.3.2), and every such message names its sender and its recipient by their DDEX Party Identifiers (DPIDs). This extension reads a DPID in its normative form and checks its check character (§3.1). It writes a NewReleaseMessage from a package’s signed works document (music-rights §5) and a statement of what the works document does not carry, taking each value where music-rights §6 maps it (§6); and it reads a message into WAI’s types (§7) within a profile (§5): the header with its sender’s and recipients’ DPIDs, the parties with their ISNIs, the sound recordings with their ISRCs, the ISWCs of the works they perform and their contributors, the AI-disclosure values (marking-layers §3.5), the release and its resources, and the deals with their use types, the two of training among them. The reader refuses what DDEX’s XML Schema refuses within the profile, each with its own reason; refuses an element, attribute or value the profile does not read; and refuses an identifier not of its published syntax, or whose check character does not check, which the schema admits. DDEX’s schema files and allowed-value sets are not in the tree: they are fetched where they are used, by address and SHA-256 (§8). No transport changes and no core text changes. The reference implementation is the release_message module of wai-rs (feature release_message); the corpus is live-conformance/release-message/, and its second implementation is live-conformance/release_message_verify.py. Keywords MUST, MUST NOT, SHOULD, MAY are RFC 2119/8174.

Texts read for this revision, fetched read-only on 14 November 2026: the DDEX Party Identifier Standard, version 1.0.1 (9 August 2024), clauses 1 to 8 and Annexes A to C; the pages of DDEX’s Knowledge Base on the DPID (DDEX Party Identifier (DPID), Do DPIDs have hyphens?, How many DPIDs do I need?, DPID registry) and on Malformed identifiers; DDEX’s Implementation Licence Terms and Conditions; and the XML Schema of ERN 4.3.2’s release notification (release-notification.xsd, its header SCOW Version v0.9.11 250618) with the allowed-value sets it imports (allowed-value-sets.xsd, version 12), each pinned by SHA-256 in §8; and the W3C Recommendations Extensible Markup Language (XML) 1.0 (Fifth Edition, 26 November 2008), Namespaces in XML 1.0 (Third Edition, 8 December 2009) and XML Schema Part 2: Datatypes (Second Edition, 28 October 2004), which the schema’s types are of. Decisions D117 and D118 state what was read of each and how DDEX’s licences bear on this extension.

The DDEX Party Identifier Standard and ERN 4.3.2 are © DDEX (the schema © 2006-2025, the allowed-value sets © 2006-2026 Digital Data Exchange, LLC). This text names the elements of the profile, the patterns of their types and the allowed values it maps, and states the DPID’s check character’s method, as far as implementing them needs, under DDEX’s Implementation Licence (§4); it reproduces no schema file and no allowed-value set.

1. Scope

In scope: the form of a DPID and the check of its check character, the identifiers of music-rights §3 as a message carries them, and an ICPN’s form (§3); what a message carries about who may exchange it (§4); the profile of ERN 4.3.2’s NewReleaseMessage this extension writes and reads (§5); writing a message from a works document and a statement (§6); reading a message into WAI’s types (§7); and holding both to DDEX’s schema, fetched where it is used (§8).

Out of scope: allocating a DPID, which DDEX does with its Implementation Licence; whether a DPID is allocated, or names the party a message says it names, which only DDEX’s registry states; every element, attribute and value of ERN 4.3.2 outside the profile, and every other message of DDEX’s standards; sending a message to anyone; the choreography of an exchange; and every legal effect of a message. WAI texts set no legal rules: this extension says what a message carries and how it is checked, and cites what DDEX’s texts say.

2. Terms

3. Identifiers

3.1 DPID

A DPID is the eighteen characters of its normative form (DDEX Party Identifier Standard clause 4.1): the identifier scheme PA (clause 4.2); the ID type DPIDA, the only one DDEX has allocated (clause 4.3); a party number of ten characters, each a digit 0–9 or a capital letter A–Z (clause 4.4); and a check character, a digit or a capital letter (clause 4.5). A string that is not of this form is dpid_malformed: among them the form a person reads, PA-DPIDA-3897722461-G, whose hyphens do not form part of the DPID (clause 4.1) and which a message does not carry (DDEX’s Knowledge Base, Do DPIDs have hyphens?); the presented form DDEX:PA-DPIDA-3897722461-G (clause 5); a string with a lower-case letter; and a string with another scheme or ID type, which no text read allocates.

No element of a DPID has a meaning of its own (clause 6): a reader does not read a date, a sequence or anything else from a party number.

The check character is ISO 7064’s MOD 37,36 (clause 4.5; Annex C gives the computation and is informative). Each character has a value: 0–9 are 0 to 9 and A–Z are 10 to 35. With p = 36, for each of the first seventeen characters a, in order from the left,

s = (p mod 37) + a
p = 2 × (s mod 36, or 36 where s mod 36 is 0)

and the check character is the one whose value c makes ((p mod 37) + c) mod 36 equal 1. A DPID of the form whose last character is not its check character is dpid_check_character. The standard’s example, PADPIDA3897722461G, is one; D117 states how Annex C’s own example is read.

The display form of a DPID is its scheme, -, its ID type, -, its party number, - and its check character (PA-DPIDA-3897722461-G).

3.2 ISRC, ISWC and ISNI

A message carries an ISRC, an ISWC and an ISNI in their normative forms only, read and checked as music-rights §3 has them, with that text’s reasons: isrc_malformed, iswc_malformed, iswc_check_digit, isni_malformed, isni_check_character. The schema types them as strings and so admits any; DDEX’s Knowledge Base says a message whose identifier field holds a string not of that identifier’s published syntax, or whose check character is wrong, can be deemed invalid (Malformed identifiers), and the reader refuses it.

3.3 ICPN

An ICPN, the bar code a release is identified by, is 8, 12, 13 or 14 digits as a message carries it; another string is icpn_malformed. The schema documents an ICPN as “a UPC, EAN, JAN or any other bar code” and gives it no form. Its check digit is not checked in this revision: the text that gives its method answered an unattended fetch with a refusal on 14 November 2026, which was not worked around.

4. Exchanging messages

A message names its sender in MessageHeader/MessageSender/PartyId and each recipient in MessageHeader/MessageRecipient/PartyId, each a DPID. The DDEX Party Identifier Standard says that a compliant message cannot be sent or received unless both its sender and its recipient have a valid DPID (Annex A, A.1). DDEX allocates a DPID with its Implementation Licence, whose terms grant a “limited, non-exclusive, non-transferable, non-sublicenseable, royalty-free licence … solely to implement the DDEX Standards within Licensee’s organisation, and use the DDEX Standards solely for the Purpose” (clause 2(i)), the Purpose being the exchange of messages between the licensee and other DDEX parties (clause 1), and reserve every other right (clause 2(v)). WAI’s code is under its own licence and grants nothing of DDEX’s: a party that exchanges messages with it does so under its own Implementation Licence and its own DPID, which the messages it sends and receives name.

5. The profile

5.1 The XML

A message is read as XML 1.0 with namespaces, in UTF-8: a document that is not well-formed (XML 1.0 §2.1, with Namespaces in XML 1.0 §7) is ern_xml_malformed. The reader reads a subset, and a well-formed document outside it is ern_xml_unsupported: a document type declaration; an XML declaration of another version or encoding; a name with a character outside ASCII; more than 16 MiB; or elements nested more than 32 deep. A byte order mark before the document is skipped. Comments and processing instructions are not read. Line ends are normalised (XML 1.0 §2.11); an attribute’s value is normalised as one of no declared type (§3.3.3); a CDATA section is text. An element’s value is its text, its pieces joined; between elements of a type with element content, text of white space only is not read.

5.2 The message

The root is NewReleaseMessage in the namespace http://ddex.net/xml/ern/432; another root is ern_not_release_message. Its children are unqualified, as the schema’s elements are: a child in a namespace is ern_element_unexpected. In the tables below, each type lists the elements the profile reads, in the schema’s order, each with the schema’s least and most occurrences (n for unbounded) and the most the profile reads; an element not listed, wherever it stands, is ern_unmapped. An attribute not listed on an element is ern_unmapped, but xsi:schemaLocation on the root, which the reader ignores; namespace declarations are not attributes.

NewReleaseMessage carries AvsVersionId (required; a text) and LanguageAndScriptCode (required; the schema’s pattern, two or three letters and then, each at most once and in this order, - and letters, - and two letters or three digits, - with a letter and four or more letters or digits). Its children:

elementschemaprofile
MessageHeader11
PartyList11
ResourceList11
ReleaseList11
DealList0–11

5.3 The header

elementschemaprofilevalue
MessageHeader/MessageThreadId0–11a text
MessageHeader/MessageId11a text
MessageHeader/MessageSender11below
MessageHeader/MessageRecipient1–n64below
MessageHeader/MessageCreatedDateTime11a date and time (§5.8)
MessageHeader/MessageControlType0–11LiveMessage or TestMessage, the whole set

MessageSender and MessageRecipient each hold PartyId (1; a DPID, §5.8) and PartyName (0–1), which holds FullName (1; a text).

5.4 Parties

PartyList holds Party (1–n; the profile reads 4 096). A Party holds PartyReference (1; an ID of pattern P and one or more of _, -, digits and letters), then PartyName (0–n; 1) and PartyId (0–n; 1), at least one of the two (the schema’s choice of PartyId, or PartyName and then PartyId; neither is ern_element_missing, named PartyId). PartyName holds FullName (1; a text). PartyId holds ISNI (0–1; an ISNI) and DPID (0–1; a DPID).

5.5 Sound recordings

ResourceList holds SoundRecording (0–n; 1 024). A SoundRecording holds:

elementschemaprofilevalue
ResourceReference11an ID of pattern A and one or more of _, -, digits and letters
Type11MusicalWorkSoundRecording or NonMusicalWorkSoundRecording
SoundRecordingEdition1–n1holds ResourceId (1–n; 1), which holds ISRC (0–1; an ISRC)
WorkId0–n32holds ISWC (0–1; an ISWC)
DisplayTitleText1–n1a text
DisplayTitle1–n1holds TitleText (1; a text)
DisplayArtistName1–n1a text
DisplayArtist1–n32below
Contributor0–n64below
Duration11a duration (§5.8)
ContainsAI0–11None, Partly or All, the whole set

A DisplayArtist carries SequenceNumber (optional; a positive integer, §5.8) and holds ArtistPartyReference (1; a reference to a party’s ID) and DisplayArtistRole (1; MainArtist or FeaturedArtist). A Contributor holds one of ContributorPartyReference (a reference to a party’s ID) and SpecialContributor (GenerativeAI), both at once being ern_element_unexpected and neither ern_element_missing (named ContributorPartyReference); then Role (0–n; 4), which holds Value (1; Composer, Lyricist, Arranger, Translator or MusicPublisher); then AiContribution (0–1; None, Partly or All, the whole set). A GenerativeAI contributor’s AI contribution is All where it states none, as the schema’s documentation of AiContribution says.

5.6 The release

ReleaseList holds Release (0–1; 1). A Release holds:

elementschemaprofilevalue
ReleaseReference11an ID of pattern R and one or more of _, -, digits and letters
ReleaseType1–n1Single, EP or Album
ReleaseId11holds ICPN (0–1; an ICPN, §3.3)
DisplayTitleText1–n1a text
DisplayTitle1–n1holds TitleText (1; a text)
DisplayArtistName1–n1a text
DisplayArtist1–n32as in §5.5
ReleaseLabelReference1–n1a reference to a party’s ID
DisplayGenre1–n1holds GenreText (1; a text)
ResourceGroup11holds ResourceGroupContentItem (0–n; 1 024), each holding SequenceNumber (0–1; a positive integer) and ReleaseResourceReference (1; a reference to a sound recording’s ID)
ContainsAI0–11None, Partly or All, the whole set

5.7 Deals

DealList holds ReleaseDeal (1–n; 64), each holding DealReleaseReference (1–n; 16; a reference to the release’s ID) and Deal (1–n; 16). A Deal holds DealTerms (0–1); a deal with none states no terms. DealTerms holds TerritoryCode (0–n; 1; Worldwide), then ValidityPeriod (1–n; 1), which holds StartDateTime (1; a date and time) and EndDateTime (0–1; a date and time), then CommercialModelType (0–n; 8; SubscriptionModel, AdvertisementSupportedModel, PayAsYouGoModel or FreeOfChargeModel) and UseType (0–n; 16; Stream, OnDemandStream, PermanentDownload, ConditionalDownload, UseForTrainingGenerativeAI or UseForTrainingNonGenerativeAI). The schema documents StartDate and EndDate as deprecated in favour of the date and time; the profile reads the latter. A territory other than Worldwide is not read in this revision: the profile holds no list of territories, and a value the allowed-value set does not hold would pass it unchecked.

5.8 Values

A value is read by its type, and refused at the first of these that applies: its form under the schema’s type (ern_value_invalid); whether the profile reads it (ern_unmapped); and an identifier’s own check (§3). White space is collapsed (XML Schema’s collapse: runs of white space to one space, none at either end) for an ID, a reference, a date and time, a duration and an integer, and kept as written for every other value.

6. Writing

6.1 The statement

The writer is given a statement: a document (route-record §2’s subset) of exactly these members:

membervalue
worksa works document’s text (music-rights §5.1)
packageexactly pack_digest (64 lowercase hexadecimal digits) and components (an array of strings): the package the works document names, as music-rights §5.3 is given it
message_ida text
thread_ida text, or null
createda date and time in the profile’s form
controlLiveMessage, TestMessage or null
languagea LanguageAndScriptCode
avs_versiona text
senderexactly dpid (a DPID) and name (a text or null)
recipientsan array of 1 to 64 objects of sender’s form
recordingsan array with one object for each recording of the works document, in its order: exactly type (a Type of §5.5), contains_ai (None, Partly, All or null) and generative (null, or exactly ai_contribution, a value or null)
releasenull, or exactly type (a ReleaseType), icpn (an ICPN or null), title (a text), artists (1 to 32 objects of exactly name, a text, and isni, an ISNI or null), label (one such object), genre (a text) and contains_ai (a value or null)
dealsan array of 0 to 16 objects of exactly start (a date and time in the profile’s form), end (one or null), commercial (0 to 8 commercial model types) and uses (0 to 16 use types)

6.2 Steps

The writer refuses at the first that applies:

  1. The statement is not of §6.1’s form: write_statement_malformed; but a DPID that is not one is refused with its reason of §3.1, an ISNI with its reason of music-rights §3.3 and an ICPN with icpn_malformed.
  2. The works document is refused by music-rights §5.3 against the package: that text’s reason.
  3. recordings does not have one object for each recording: write_statement_malformed.
  4. A recording of the works document names no artist, so its DisplayArtist, which the schema requires, has nothing to hold: write_artist_missing.
  5. deals is not empty and release is null, so a deal names no release: write_deal_without_release.

Otherwise it writes the message of §6.3.

6.3 The message written

The parties are music-rights §6.2’s, numbered P1 on, followed by the release’s artists and then its label, each where no party before it has its name and ISNI. Every value music-rights §6.2 and §6.3 map is written where they map it; the statement gives the rest:

The bytes are fixed, so two writers write the same message: the declaration <?xml version="1.0" encoding="UTF-8"?>, the root as ern:NewReleaseMessage with xmlns:ern="http://ddex.net/xml/ern/432", AvsVersionId and LanguageAndScriptCode in that order, every element on a line of its own indented two spaces for each level below the root, an element of a value on one line, an element of no content as <Name/>, attributes in double quotes, &, < and > written &amp;, &lt; and &gt; (and " as &quot; in an attribute), line ends LF, and a line end after the root’s end tag. A duration is written PT, its hours and its minutes where not 0, and its seconds, with its milliseconds after a point and their trailing zeros left out (PT3M25.5S, PT1H2M3.45S, PT3M0S).

A message the writer writes is in the profile, and the reader reads it back to the same values.

7. Reading

7.1 Steps

The reader refuses at the first that applies, with the reason and the path:

  1. The document is not well-formed, or outside §5.1’s subset: ern_xml_malformed or ern_xml_unsupported.
  2. The root is not ERN 4.3.2’s NewReleaseMessage: ern_not_release_message.
  3. Then, from the root down, for each element: its attributes in document order (an attribute not read is ern_unmapped, a value refused by §5.8), then each required attribute (ern_attribute_missing).
  4. Its children in order (§5.2 to §5.7): text other than white space where the type holds elements is ern_element_unexpected, as is a child in a namespace; a child not listed is ern_unmapped; a child listed before one already read, or past the schema’s most, is ern_element_unexpected, and past the profile’s most ern_unmapped; a required child absent is ern_element_missing, at the first child after the place it would hold or at the end; then the choices of §5.4 and §5.5.
  5. Then each child, in order, by steps 3 to 5; a child of a value holds no element (ern_element_unexpected) and its value is read by §5.8.
  6. After the walk, each reference in document order names an ID of the message: ern_reference_dangling.
  7. Two sound recordings carry one ISRC, which names one recording only (music-rights §5.3): isrc_repeated, at the second.

7.2 What the reader gives

A message read gives WAI’s types: its AvsVersionId and LanguageAndScriptCode; its header (thread, message id, sender and recipients each with its DPID and name, the time it was created and its control type); its parties (reference, name, ISNI, DPID, each or null); its sound recordings (reference, type, ISRC or null, the ISWCs of its works, title, display artist name, display artists with party, role and sequence number, contributors with party or GenerativeAI, roles and AI contribution, duration in milliseconds, ContainsAI or null); its release (reference, type, ICPN or null, title, display artist name, display artists, label, genre, the references of its resources, ContainsAI or null) or null; and its deals, flattened over their ReleaseDeals, each with the releases it names and its terms or null. It states what the message leaves unknown: the recordings with no ISRC, the parties with no ISNI, and the recordings and release that state no ContainsAI. And it states the AI-disclosure values marking-layers §3.5 reads: the release’s ContainsAI, and for each sound recording its reference, its ContainsAI and each contributor that is GenerativeAI or states an AiContribution.

Unknown stays unknown: a value the message does not state is null, never filled.

8. The schema

The reader’s acceptance is held to the schema, and the writer’s output too: every message the writer writes, and every message the reader accepts, validates against it. Of a message with one defect, one refused with a reason of the schema’s class (§9) fails validation, and one refused with an identifier’s reason validates; the profile’s reasons say nothing of the schema. The corpus states each refused message’s verdict, measured with the schema (§10).

DDEX’s files are not in the tree, and are fetched where they are used, each by its address and held to its SHA-256 before it is used, by live-conformance/release-message/fetch.sh:

fileaddressSHA-256
release-notification.xsd (624 343 bytes)https://service.ddex.net/xml/ern/432/release-notification.xsd36110e2149336d35e90ea4822daca72961c121dcc6b5cf5b794048b50f6c1e8a
allowed-value-sets.xsd (3 489 249 bytes, version 12)https://service.ddex.net/xml/allowed-value-sets/allowed-value-sets.xsd03f290c5a6715e45dcdde5f4fa2b44821c3372331f5bec0b17c802d6fa0e8385

The allowed-value sets are published at one address for every version; when the address serves a later version, the fetch fails rather than validate against other sets, and this table and the profile’s values are read again. The schema imports the sets from http://ddex.net/xml/allowed-value-sets/allowed-value-sets.xsd, an address that redirects to the one above over plain HTTP; the fetch takes the HTTPS address, and an XML catalog resolves the imported address to the fetched file, so validation uses no network.

9. Reasons

reasonraised atclass
dpid_malformed§3.1, §5.8, §6.2 step 1identifier
dpid_check_character§3.1, §5.8, §6.2 step 1identifier
icpn_malformed§3.3, §5.8, §6.2 step 1identifier
ern_xml_malformed§5.1, §7.1 step 1schema
ern_xml_unsupported§5.1, §7.1 step 1profile
ern_not_release_message§5.2, §7.1 step 2schema
ern_element_unexpected§5.2, §7.1 steps 4 and 5schema
ern_element_missing§7.1 step 4schema
ern_attribute_missing§7.1 step 3schema
ern_value_invalid§5.8schema
ern_reference_duplicate§5.8schema
ern_reference_dangling§5.8, §7.1 step 6schema
ern_unmapped§5.2, §5.8, §7.1 steps 3 and 4profile
write_statement_malformed§6.2 steps 1 and 3writer
write_artist_missing§6.2 step 4writer
write_deal_without_release§6.2 step 5writer
isrc_malformed§3.2 (music-rights §3.1)identifier
iswc_malformed§3.2 (music-rights §3.2)identifier
iswc_check_digit§3.2 (music-rights §3.2)identifier
isni_malformed§3.2 (music-rights §3.3)identifier
isni_check_character§3.2 (music-rights §3.3)identifier
isrc_repeated§7.1 step 7 (music-rights §5.3)identifier

The writer also gives every reason of music-rights §5.3 for a works document it refuses (§6.2 step 2).

10. Conformance

live-conformance/release-message/ holds the corpus, in one file, vectors.json, written from fixed inputs by wai_release_message_vectors gen:

Every reason of §9 has a case refused with it, and every check of the second implementation a case that fails without it. The accepted reads include messages written otherwise than §6.3 writes (a comment, the schema’s location, single quotes, a CDATA section, CR LF line ends, white space around a reference) and gaps: identifiers unknown, values unstated, a deal with no terms. Among the refused, each a fixed edit of a message the writer wrote and a control of one defect: a document cut short and an undeclared entity; a document type declaration, another encoding, a processing instruction named outside ASCII and elements nested too deep; another namespace; an element out of order, a child in ERN’s namespace, text in the header, an element twice, an element holding one where a value goes, and a contributor with both a party and GenerativeAI; a required element, a required attribute, a party’s name and identifier, and a contributor’s party removed; a value outside a set held whole, an impossible date, a language code and a reference off their patterns, a duration in clock form and an integer with a fraction; a DPID with hyphens, one too short and one whose check character is wrong; an ID twice and a dangling reference; an element, an attribute, a second title, an empty text, a time with no offset, a duration of four decimals, a signed integer and a value the profile does not read; an ISRC in lower case and in its display form; an ISWC whose check digit is wrong and one in its display form; an ISNI whose check character is wrong and one in groups; a short ICPN; and one ISRC on two recordings.

A conforming implementation gives every case the outcome the corpus states. wai_release_message_vectors verify and the test tests/release_message.rs check that the file regenerates byte for byte and that wai-rs gives every case its outcome. live-conformance/release_message_verify.py is the second implementation, written from this text and sharing no code with wai-rs: it writes every statement’s message itself and requires the same bytes, reads every message itself, mutates copies of the corpus and drops each of its own checks in turn, and requires each to be caught. With --schema, it validates every message the corpus holds against the schema fetch.sh fetched, with the xmllint fetch.sh builds, and holds each case’s schema to the verdict.

11. Security and privacy considerations