Guides and Resources
Start typing to search…

Message Header and Footer

Example Message Header

<?xml version="1.0" encoding="UTF-8"?>
<ern:NewReleaseMessage MessageSchemaVersionId="ern/382" LanguageAndScriptCode="en" xs:schemaLocation="&lt;http://ddex.net/xml/ern/382&gt; &lt;http://ddex.net/xml/ern/382/release-notification.xsd&gt;" xmlns:xs="&lt;http://www.w3.org/2001/XMLSchema-instance&gt;" xmlns:ernm="&lt;http://ddex.net/xml/ern/382&gt;">
    <MessageHeader>
        <MessageThreadId>unique-thread-id-12345</MessageThreadId>
        <MessageId>unique-message-id-12345</MessageId>
        <MessageSender>
            <PartyId>exampleSender-DPID</PartyId>
            <PartyName>
                <FullName>Sender-Party-Name</FullName>
            </PartyName>
        </MessageSender>
        <SentOnBehalfOf>
            <PartyId>exampleSender-DPID</PartyId>
            <PartyName>
                <FullName>Reporting-Party-Name</FullName>
            </PartyName>
        </SentOnBehalfOf>
        <MessageRecipient>
            <PartyId>PADPIDA2011021601H</PartyId>
            <PartyName>
                <FullName>MassiveMusic</FullName>
            </PartyName>
        </MessageRecipient>
        <MessageCreatedDateTime>2024-06-05T12:00:00Z</MessageCreatedDateTime>
        <MessageControlType>LiveMessage</MessageControlType>
    </MessageHeader>
</ern:NewReleaseMessage>

Message Header Overview

The Message Header is critical in identifying the transaction details of a digital music delivery package. Here’s a breakdown of what this includes:

Components of the Message Header

  • MessageThreadId: A unique identifier that groups together related messages into a single thread. This helps in tracking conversations or sequences of messages about a specific issue or transaction. Example: <MessageThreadId>unique-thread-id-12345</MessageThreadId>.

  • MessageId: A unique identifier for each message sent. This is crucial for tracking and referencing individual messages. Example: <MessageId>unique-message-id-12345</MessageId>.

  • MessageSender: This section details the sender of the message including:

    • PartyId: A unique identifier for the party sending the message, often a DDEX Party ID. Example: <PartyId>exampleSender-DPID</PartyId>.
    • PartyName: The full name of the sender. Example: <FullName>Sender-Party-Name</FullName>.

  • SentOnBehalfOf: Indicates if the message is being sent on behalf of another party. This section is similar to MessageSender in structure containing:

    • PartyId: DDEX Party ID of the entity on whose behalf the message is being sent. Example: <PartyId>exampleSender-DPID</PartyId>.
    • PartyName: Full name of the reporting party. Example: <FullName>Reporting-Party-Name</FullName>.

  • MessageRecipient: This section specifies the intended recipient of the message:

    • PartyId: The recipient’s unique identifier, typically a DDEX Party ID. Example: <PartyId>PADPIDA2011021601H</PartyId>.
    • PartyName: The full name of the recipient. Example: <FullName>MassiveMusic</FullName>.

  • MessageCreatedDateTime: The exact date and time the message was created, formatted in ISO 8601 standard. This timestamp ensures that the sequence of messages is maintained accurately. Example: <MessageCreatedDateTime>2024-06-05T12:00:00Z</MessageCreatedDateTime>.

  • MessageControlType: Specifies the type of the message such as LiveMessage or TestMessage, indicating whether the message is part of actual data exchange or merely for testing purposes. Example: <MessageControlType>LiveMessage</MessageControlType>.

The <UpdateIndicator> Element

The <UpdateIndicator> element follows the closing of the </MessageHeader> and specifies the type of message being sent within the DDEX ERN. It indicates whether the message is an originator update notification.

  • Description:

    • Element: <UpdateIndicator>
    • Value: OriginalMessage

  • Value Explanation:

    • OriginalMessage: This value indicates that the message is an original, initial notification about the release. It means the metadata and associated information being provided have not been previously sent and this is the first instance of this particular data being communicated to MassiveMusic.
    • UpdateMessage: This value indicates that the message is an update to previously sent information about a release. It means the metadata and associated information being provided have already been communicated in an earlier message, and this message serves to modify, correct, or supplement that original data.

Closing the ERN Message

The </ern:NewReleaseMessage> element is used to signify the end of a DDEX ERN message that provides information about a new release. This element ensures that the message is correctly terminated, allowing our system to process it properly.

<ern:NewReleaseMessage MessageSchemaVersionId="ern/382" LanguageAndScriptCode="en" xs:schemaLocation="&lt;http://ddex.net/xml/ern/382&gt; &lt;http://ddex.net/xml/ern/382/release-notification.xsd&gt;" xmlns:xs="&lt;http://www.w3.org/2001/XMLSchema-instance&gt;" xmlns:ernm="&lt;http://ddex.net/xml/ern/382&gt;">
    <!-- Metadata and information about the new release -->
</ern:NewReleaseMessage>

Updated 3 months ago