Skip to end of metadata
Go to start of metadata

8.3.1 Syntax and Semantics

ccho:ManifestMessage

A Message in the CCHO DdexMessageSuite that is sent to document the FTP transfer of a batch of Messages.

Message Element

Data Type

Card

Element Description

MessageVersionId

String

1

The Version of the Message.

MessageHeader

amep:FtpMessageHeader

1

The MessageHeader for the ManifestMessage.

 

MessageSender

ddexC:MessagingParty

1

A Composite containing details of the MessageSender.

 

 

LanguageAndScriptCode

String

0-1

The Language and script for the Elements of the MessagingParty as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

PartyId

ddexC:PartyId

1

A Composite containing details of the PartyId for the Party handling the Message. If no Namespace is given, the Identifier is a DdexPartyId (DPID). Note that DPIDs are not normally used to identify Artists, Producers or other Creators.

 

 

 

Namespace

String

0-1

The Namespace of the PartyId if it belongs to a proprietary Party ID scheme. If the PartyId is a DPID, the Namespace Element must not be used. This is represented in an XML schema as an XML Attribute.

 

 

PartyName

ddexC:PartyName

0-1

A Composite containing details of the PartyNames for the Party handling the Message.

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script for the Elements of the PartyName as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

FullName

ddexC:Name

1

A Composite containing the complete Name of the Party, in its normal form of presentation (e.g. John H. Smith, Acme Music Inc, A Composite containing the Beatles).

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

FullNameAsciiTranscribed

String

0-1

The FullName transcribed using 7-bit ASCII code.

 

 

 

FullNameIndexed

ddexC:Name

0-1

A Composite containing the complete Name of the Party in the form in which it normally appears in an alphabetic index, with the KeyName first (e.g. Smith, John H.; Beatles, A Composite containing the).

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

NamesBeforeKeyName

ddexC:Name

0-1

A Composite containing the Name(s) preceding the KeyName in the FullName (and that is placed after it in a FullNameIndexed). Examples: "George" in "George Michael"; "John Fitzgerald" in "John Fitzgerald Kennedy". Not all PartyNames have a NamesBeforeKeyName (e.g. Madonna, EMI Music Inc).

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

KeyName

ddexC:Name

0-1

A Composite containing the Part of a Name of the Party normally used to index an entry in an alphabetical list, such as "Smith" (in John Smith) or "Garcia Marquez" or "Madonna" or "Francis de Sales" (in Saint Francis de Sales). For persons, this normally corresponds to the "family name" or names, which in Western name forms usually comes as a surname at the end of a FullName, and in Asian name forms often at the beginning of a FullName.

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

NamesAfterKeyName

ddexC:Name

0-1

A Composite containing the Name(s) following the KeyName. Example:"Ibrahim" (in Anwar Ibrahim). This is common, e.g., in many Asian personal name forms where a FullName begins with the KeyName, which is followed by other names.

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

AbbreviatedName

ddexC:Name

0-1

A Composite containing a short version of the PartyName (e.g. for use on devices with a small display).

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

TradingName

ddexC:Name

0-1

A Composite containing a TradingName for the Party handling the Message.

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

MessageRecipient

ddexC:MessagingParty

1

A Composite containing details of the MessageRecipient.

 

 

LanguageAndScriptCode

String

0-1

The Language and script for the Elements of the MessagingParty as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

PartyId

ddexC:PartyId

1

A Composite containing details of the PartyId for the Party handling the Message. If no Namespace is given, the Identifier is a DdexPartyId (DPID). Note that DPIDs are not normally used to identify Artists, Producers or other Creators.

 

 

 

Namespace

String

0-1

The Namespace of the PartyId if it belongs to a proprietary Party ID scheme. If the PartyId is a DPID, the Namespace Element must not be used. This is represented in an XML schema as an XML Attribute.

 

 

PartyName

ddexC:PartyName

0-1

A Composite containing details of the PartyNames for the Party handling the Message.

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script for the Elements of the PartyName as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

FullName

ddexC:Name

1

A Composite containing the complete Name of the Party, in its normal form of presentation (e.g. John H. Smith, Acme Music Inc, A Composite containing the Beatles).

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

FullNameAsciiTranscribed

String

0-1

The FullName transcribed using 7-bit ASCII code.

 

 

 

FullNameIndexed

ddexC:Name

0-1

A Composite containing the complete Name of the Party in the form in which it normally appears in an alphabetic index, with the KeyName first (e.g. Smith, John H.; Beatles, A Composite containing the).

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

NamesBeforeKeyName

ddexC:Name

0-1

A Composite containing the Name(s) preceding the KeyName in the FullName (and that is placed after it in a FullNameIndexed). Examples: "George" in "George Michael"; "John Fitzgerald" in "John Fitzgerald Kennedy". Not all PartyNames have a NamesBeforeKeyName (e.g. Madonna, EMI Music Inc).

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

KeyName

ddexC:Name

0-1

A Composite containing the Part of a Name of the Party normally used to index an entry in an alphabetical list, such as "Smith" (in John Smith) or "Garcia Marquez" or "Madonna" or "Francis de Sales" (in Saint Francis de Sales). For persons, this normally corresponds to the "family name" or names, which in Western name forms usually comes as a surname at the end of a FullName, and in Asian name forms often at the beginning of a FullName.

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

NamesAfterKeyName

ddexC:Name

0-1

A Composite containing the Name(s) following the KeyName. Example:"Ibrahim" (in Anwar Ibrahim). This is common, e.g., in many Asian personal name forms where a FullName begins with the KeyName, which is followed by other names.

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

 

AbbreviatedName

ddexC:Name

0-1

A Composite containing a short version of the PartyName (e.g. for use on devices with a small display).

 

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

 

TradingName

ddexC:Name

0-1

A Composite containing a TradingName for the Party handling the Message.

 

 

 

LanguageAndScriptCode

String

0-1

The Language and script of the Name as defined in IETF RfC 4646. The default is the same as indicated for the containing composite. Language and Script are provided as lang[-scipt][-region][-variant]. This is represented in an XML schema as an XML Attribute.

 

MessageCreatedDateTime

DateTime

1

The DateTime on which the Message was created (the only allowed format is ISO 8601:2004: YYYY-MM-DDThh:mm:ssTZD).

 

XmlChoice

 

0-1

An XmlComposite corresponding to the xs:choice element in an XML document or schema.

 

 

HashSum

ddexC:HashSum

1

A Composite containing a HashSum and information about the algorithm with which it has been generated.

 

 

 

HashSum

String

1

The value of the HashSum.

 

 

 

HashSumAlgorithmType

ddexC:HashSumAlgorithmType

1

A Composite containing details of the Type of HashSumAlgorithm governing the HashSum.

 

 

 

 

Namespace

String

0-1

The Namespace of the HashSumAlgorithmType. This is represented in an XML schema as an XML Attribute.

 

 

 

 

UserDefinedValue

String

0-1

A UserDefined value of the HashSumAlgorithmType. This is represented in an XML schema as an XML Attribute.

 

 

Signature

ftpx/amep:Signature (ds:Signature)

1

A digital signature in accordance with DDEX-DSIG.

IsTestFlag

Boolean

1

The Flag indicating whether the Message is a TestMessage (=True) or a LiveMessage (=False).

RootDirectory

String

1

An Identifier of the root directory of all Messages in the batch communicated through the ManifestMessage.

NumberOfMessages

Integer

1

The number of Messages in the batch communicated through the ManifestMessage.

MessageInBatch

ddexC:ErnMessageInBatch

1-n

A Composite containing details of an ERN Message in the batch.

 

MessageType

ErnMessageType

1

The Type of Message.

 

MessageId

String

1

An Identifier of the Message.

 

URL

String

1

A URL of the Message.

 

IncludedReleaseId

ddexC:ReleaseId

1-n

A Composite containing details of ReleaseIds. If available, a GRid should always be used.

 

 

IsReplaced

Boolean

0-1

The Flag indicating whether this Identifier is old and has been replaced by a new one (=True) or not (=False). The Flag may only be set to True when the new Identifier is also provided. If the Flag is not set, this Identifier is deemed to be the current one.

 

 

GRid

String

0-1

The GRid identifying the Release. This is the preferred Element and is mandatory if a GRid is available. A GRid comprises four parts: the string "A1", followed by five alphanumeric characters, ten alphanumeric characters and and one alphanumeric character.

 

 

ISRC

String

0-1

The ISRC (International Standard Recording Code as defined in ISO 3901) used as proxy for identification of the Release. Only applicable when the Release only contains one SoundRecording or one MusicalWorkVideo. An ISRC comprises four parts: two characters, followed by three alphanumeric characters, then two digits and five digits.

 

 

ICPN

ddexC:ICPN

0-1

A Composite containing details of the ICPN used as proxy for identification of the Release. Only applicable when the Release is an abstraction of a complete PhysicalProduct. An ICPN comprises 12 or 13 digits, depending whether it is an EAN (13) or a UPC (12).

 

 

 

IsEan

Boolean

1

The Flag indicating whether the ICPN is specifically an EAN (=True) or a UPC (=False). This is represented in an XML schema as an XML Attribute.

 

 

CatalogNumber

ddexC:CatalogNumber

0-1

A Composite containing details of the CatalogNumber of the Release.

 

 

 

Namespace

String

1

The Namespace of the CatalogNumber. This is represented in an XML schema as an XML Attribute.

 

 

ProprietaryId

ddexC:ProprietaryId

0-n

A Composite containing details of a ProprietaryIdentifier of the Release.

 

 

 

Namespace

String

1

The Namespace of the ProprietaryId. This is represented in an XML schema as an XML Attribute.

 

DeliveryType

ddexC:MessageActionType

1

A Composite containing details of the Type of action that the MessageSender applies to the Message.

 

 

Namespace

String

0-1

The Namespace of the MessageActionType. This is represented in an XML schema as an XML Attribute.

 

 

UserDefinedValue

String

0-1

A UserDefined value of the MessageActionType. This is represented in an XML schema as an XML Attribute.

 

ProductType

ddexC:ProductType

1

A Composite containing details of the Type of a Product defining which kinds of Products are within the delivered batch. Each batch may only contain one type of Products.

 

 

Namespace

String

0-1

The Namespace of the ProductType. This is represented in an XML schema as an XML Attribute.

 

 

UserDefinedValue

String

0-1

A UserDefined value of the ProductType. This is represented in an XML schema as an XML Attribute.

 

XmlChoice

 

0-1

An XmlComposite corresponding to the xs:choice element in an XML document or schema.

 

 

HashSum

ddexC:HashSum

1

A Composite containing a HashSum of the File and information about the algorithm with which it has been generated.

 

 

 

HashSum

String

1

The value of the HashSum.

 

 

 

HashSumAlgorithmType

ddexC:HashSumAlgorithmType

1

A Composite containing details of the Type of HashSumAlgorithm governing the HashSum.

 

 

 

 

Namespace

String

0-1

The Namespace of the HashSumAlgorithmType. This is represented in an XML schema as an XML Attribute.

 

 

 

 

UserDefinedValue

String

0-1

A UserDefined value of the HashSumAlgorithmType. This is represented in an XML schema as an XML Attribute.

 

 

Signature

ftpx/amep:Signature (ds:Signature)

1

A digital signature in accordance with DDEX-DSIG.

  • No labels
Write a comment…