6.8 Structure of the Musical Work Cluster Request

The structure of the MusicalWorkClusterRequest is described in below. MusicalWorkClusterRequests shall be communicated with the message exchange protocol defined in Part 1 of the ECM standard.

The MusicalWorkClusterRequest can be used to communicate can be used to communicate requests for Musical Work Clusters and contains four sub-elements as depicted in Figure 9:

• A mandatory @AvsVersionId communicates the version of the allowed value sets used in the message;

• The mandatory LanguageAndScriptCode communicates the language and script for the elements of the message as defined in IETF RfC 5646. Language and script are communicated using the syntax lang[-script][-region][-variant];

• A mandatory MessageHeader communicates general message metadata as depicted in Figure 4; and

• A mandatory array of RequestedClusters as depicted in Figure 10 that requests data regarding 1-n Musical Work Clusters through:

  • A mandatory ClusterID (which is expected to be included as a RequestedClusterId in the responding MusicalWorkClusterNotification); and

  • 0-n Work or 0-n Resource composites, however at least one Work or Resource needs to be provided.

When requesting a cluster based on a musical work it is mandatory to send an ISWC or both Writer and Title. It is permissible to also send ISWC, Writer and Title together.

The recipient of as MusicalWorkClusterRequest may decide to reply with MusicalWorkClusterNotification.

Figure 9 – Structure of the MusicalWorkClusterRequest

Figure 10 – Structure of the RequestedCluster composite