Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AccountFavouriteResource
  • /accountfavourites/{userId}
  • /accountfavourites/{userId}/prepare
  • GET
  • POST
AccountFolderResource
  • /accountfolders
  • /accountfolders/{accountFolderId}/prepare
  • GET
  • POST
AgreementResource
  • /agreements
  • /agreements/{agreementId}
  • GET POST
  • DELETE PUT
AgreementSocietyRelationshipResource
  • /agreementsocietyrelationships
  • /agreementsocietyrelationships/{agreementSocietyRelationshipId}
  • GET POST
  • DELETE PUT
AlbumHierarchyNodeRelationshipResource
  • /albumhierarchynoderelationships/{albumHierarchyNodeRelationshipId}/prepare
  • POST
AlbumResource
  • /albums
  • /albums/{albumId}
  • /albums/{albumId}/prepare
  • GET POST
  • DELETE PUT
  • POST
AudioFileResource
  • /audiofiles
  • /audiofiles/{audioFileId}
  • POST
  • DELETE PUT
BroadcasterResource
  • /broadcasters
  • /broadcasters/{broadcasterId}
  • GET POST
  • DELETE PUT
BroadcasterTerritoryRelationshipResource
  • /broadcasterterritoryrelationships
  • /broadcasterterritoryrelationships/{broadcasterTerritoryRelationshipId}
  • GET POST
  • DELETE PUT
DocumentResource
  • /documents
  • /documents/{handle}
  • GET POST
  • GET
GenreResource
  • /genres
  • /genres/{genreId}
  • GET POST
  • DELETE PUT
HierarchyNodeResource
  • /hierarchynodes
  • /hierarchynodes/{hierarchyNodeId}/prepare
  • GET
  • POST
ImportableBatchResource
  • /importablebatches
  • /importablebatches/{importableBatchId}
  • /importablebatches/{importableBatchId}/events
  • GET POST
  • DELETE PUT
  • GET POST
ImportableFileResource
  • /importablefiles
  • /importablefiles/{importableFileId}
  • GET POST
  • DELETE
ImportableTrackResource
  • /importabletracks
  • /importabletracks/{importableTrackId}
  • GET POST
  • DELETE
KeywordResource
  • /keywords
  • /keywords/{keywordId}
  • GET POST
  • DELETE PUT
LibraryOwnerResource
  • /libraryowners
  • /libraryowners/{libraryOwnerId}
  • GET POST
  • DELETE PUT
LibraryResource
  • /libraries
  • /libraries/{libraryId}
  • GET POST
  • DELETE PUT
NotificationResource
  • /notifications
  • POST
OriginalPublisherLibraryRelationshipResource
  • /originalpublisherlibraryrelationships
  • /originalpublisherlibraryrelationships/{originalPublisherLibraryRelationshipId}
  • GET POST
  • DELETE PUT
OriginalPublisherResource
  • /originalpublishers
  • /originalpublishers/{originalPublisherId}
  • GET POST
  • DELETE PUT
PreparedDownloadResource
  • /prepareddownloads/{id}
  • /prepareddownloads/{id}/{partId}
  • GET
  • GET
SearchResource
  • /search/autocomplete
  • /search/suggestions
  • GET
  • GET
ShareResource
  • /shares
  • /shares/{oldShareIds}
  • /shares/{shareIds}
  • GET POST
  • PUT
  • DELETE
SocietyResource
  • /societies
  • /societies/{societyId}
  • GET POST
  • DELETE PUT
StakeholderResource
  • /stakeholders
  • /stakeholders/{stakeholderId}
  • GET POST
  • DELETE PUT
StakeholderSocietyRelationshipResource
  • /stakeholdersocietyrelationships
  • /stakeholdersocietyrelationships/{stakeholderSocietyRelationshipId}
  • GET POST
  • DELETE PUT
StatisticsResource
  • /statistics/onlineuseractivity
  • /statistics/stakeholder
  • /statistics/timeline
  • GET
  • GET
  • GET
SubPublisherResource
  • /subpublishers
  • /subpublishers/{subPublisherId}
  • GET POST
  • DELETE PUT
TaskResource
  • /tasks
  • /tasks/{taskId}
  • GET POST
  • GET
TerritoryResource
  • /territories
  • /territories/{territoryId}
  • GET POST
  • DELETE PUT
TrackAgreementRelationshipResource
  • /trackagreementrelationships
  • /trackagreementrelationships/{oldTrackAgreementRelationshipIds}
  • /trackagreementrelationships/{trackAgreementRelationshipIds}
  • GET POST
  • PUT
  • DELETE
TrackGenreRelationshipResource
  • /trackgenrerelationships
  • /trackgenrerelationships/{trackGenreRelationshipIds}
  • /trackgenrerelationships/{trackGenreRelationshipId}
  • GET POST
  • DELETE
  • PUT
TrackKeywordRelationshipResource
  • /trackkeywordrelationships
  • /trackkeywordrelationships/{trackKeywordRelationshipIds}
  • /trackkeywordrelationships/{trackKeywordRelationshipId}
  • GET POST
  • DELETE
  • PUT
TrackResource
  • /tracks
  • /tracks/search
  • /tracks/{trackId}
  • /tracks/{trackId}/download
  • /tracks/{trackId}/stream
  • /tracks/{trackId}/streamed
  • /tracks/{trackId}/waveform
  • GET POST
  • GET
  • DELETE PUT
  • GET
  • GET
  • PUT
  • GET

Data Types

XML

Default Namespace (schema)
type description
MTAgreement An MTAgreement represents a contract for a MTTrack between (1) a MTOriginalPublisher, (2) a MTSubPublisher and (3) a MTSociety. The first entity is non-society specific and may be found here on the agreement itself. However, an agreement may exist in multiple societies and society specific data for an agreement such as MTSubPublisher and MTSociety may be found for the applicable society in the MTAgreementSocietyRelationships collection. This means that to retrieve all three entities which takes part in any given agreement, one must first retrieve the first entity from this agreement itself. Next, from the MTAgreementSocietyRelationships collection one must retrieve the MTAgreementSocietyRelationship which represents the relevant MTSociety and finally retrieve the last entity which is the MTSubPublisher.
MTAgreementSocietyRelationship A MTAgreementSocietyRelationship represents a relationship between a MTAgreement and a MTSociety. Specifically, this entity holds the MTSociety and the MTSubPublisher which always will be society specific for any given agreement along with any other society specific data for any given MTAgreement.
MTAgreementSocietyRelationshipStatus
MTAgreementSocietyRelationshipStatusSubStatus
MTAlbum A MTAlbum represents a collection of MTTrack.
MTAlbumStatus
MTAudioFile A MTAudioFile represents audio data of a given format.
MTAudioFileQuality
MTAudioFileType
MTBroadcaster
MTBroadcasterTerritoryRelationship
MTGenre A MTGenre represents a genre.
MTHierarchyNode A MTHierarchyNode represents a hierarchy node (folder).
MTKeyword A MTKeyword represents a keyword.
MTLibrary A MTLibrary represents a library. A library may be associated with one or more albums.
MTLibraryStatus
MTLibraryOwner A MTLibraryOwner represents a library owner. A library owner may be associated with one or more libraries.
MTOriginalPublisher A MTOriginalPublisher represents an original publisher.
MTOriginalPublisherLibraryRelationship A MTOriginalPublisherLibraryRelationship represents a relationship between a library and an original publisher.
MTShare a MTShare represents a Stakeholder which has an interest in a track.
MTShareRole
MTSociety A MTSociety represents a society, or performing rights organisation (PRO). Throughout this API, this entity will be referred to as a society.
MTStakeholder An MTStakeholder represents a stakeholder which can take part in one or more MTShare.
MTStakeholderType An type which describes any given MTStakeholder.
MTStakeholderSocietyRelationship A MTStakeholderSocietyRelationship represents a relationship between a MTStakeholder and a MTSociety.
MTSubPublisher A MTSubPublisher represents a sub publisher.
MTTerritory a MTTerritory represents a territory.
MTTrack An MTTrack represents a musical work.
MTTrackStatus
MTTrackVersionType
MTTrackAgreementRelationship A MTTrackAgreementRelationship represents a relationship between a MTTrack and a MTAgreement. It thus represents an agreement which a track is associated with.
MTTrackGenreRelationship A MTTrackGenreRelationship represents a relationship between a MTTrack and a MTGenre. It thus represents a genre which a track is associated with.
MTTrackHierarchyNodeRelationship A MTTrackHierarchyNodeRelationship represents a relationship between a MTTrack and a MTHierarchyNode. It thus represents a hierarchy node which a track is associated with.
MTTrackKeywordRelationship A MTTrackKeywordRelationship represents a relationship between a MTTrack and a MTKeyword. It thus represents a keyword which a track is associated with.
MTImportableBatch
MTPriority
MTImportableBatchEvent
MTImportableFile
MTImportableFileType
MTImportableTrack
MTOnlineUserActivityStatistics
MTOnlineUserActivity
MTOnlineUserActivityEntity
MTOnlineUserActivityStatisticsEntityType
MTOnlineUserActivityStatisticsGranularity
MTNotification
MTPreparedDownload
MTPreparedDownloadPart