5.3.2 Hub-based Choreography Introduction

The processes of communicating through a Hub comprises the following steps, it should be noted, that the approach to the communication between (prospective) Licensee and a Hub, and the communication between a (prospective) Licensor and the Hub are (virtually) identical:


  1. Communication between a (prospective) Licensee and a Hub:

    1. The (prospective) Licensee calls the web service endpoint published by the Hub using the POST ClaimRequest call with a MusicalWorkRightsClaimRequestMessage;  

    2. Until the (prospective) Licensee has received claims for all of its claim requests, it regularly calls the Hub's web service with a GET ClaimNotificationList call.  

    3. The  Hub replies to this call with an Atom feed providing URLs for all MusicalWorkRightsClaimNotificationMessages that are ready to be collected;

    4. The (prospective) Licensee can then call the Hub's GET ClaimNotification web service endpoint for each URL provided in Step 1c; and  

    5. The  Hub will respond with the requested MusicalWorkRightsClaimNotificationMessage;

  2. Communication between a (prospective) Licensor and a Hub:

    1. The (prospective) Licensor regularly calls the Hub 's web service with a GET ClaimRequestList call.  

    2.   The  Hub replies to this call with an Atom feed providing a URL for all MusicalWorkRightsClaimRequestMessage s that are ready to be collected;

    3. The (prospective) Licensor can then call the Hub's GET ClaimRequest web service endpoint for each URL provided in Step 2b;  

    4. The  Hub replies to this call with a MusicalWorkRightsClaimRequestMessage; and

    5. The (prospective) Licensor then collates the relevant information and calls the Hub 's POST ClaimNotification end point with a MusicalWorkRightsClaimNotificationMessage. Identification of specific Claim Requests

One crucial aspect for companies making or releasing (or planning to make or release) a sound recording that makes use of a Musical Work is to establish the various applicable Right Shares for said Musical Work. For this, a (prospective) Licensee typically does some research in order to collate a list of companies it believes own or administer (part of) the Musical Work and from whom a licence can be sought. The company would typically then contact all (prospective) Licensors to establish their Shares before attempting to obtain licences.

When obtaining such Right Share information from a Hub, it is essential that the (prospective) Licensee can link right share notifications to its Right Share requests so that it can determine if all of its requests have been replied to (or not). To support this, MusicalWorkRightsClaimRequestMessage and MusicalWorkRightsClaimNotificationMessage carry identifiers that a Hub will need to handle appropriately as follows:

Field in the MusicalWorkRightsClaimRequestMessage (as provided by the prospective Licensee to the Hub)

The //Request/MusicalWorkShareRequest/RightsControllerRequestId contains a proprietary ID of the (prospective) Licensee for the share request with respect to the (possible) Licensor referenced in //Request/MusicalWorkShareRequest/RequestRightsControlleReference

Field in the MusicalWorkRightsClaimNotificationMessage (as provided by the prospective Hub to the prospective Licensee)

//RightsShareNotofication/RequestRightShareReference/RightsControllerRequest shall contain the proprietary ID listed in the left column for any RightShare information provided in response to a request with said proprietary ID.

The field shall be omitted in all other cases.