JSON Specification

SECTION

DESCRIPTION

Sub Objects

Ref

REQ?

Album

releaseId

2.21

Y

Album

action

2.22

Y

Album

upc

2.23

Y

Album

grid

2.24

N

Album

type

2.25

Y

Album

title

display

2.26

Y

Album

title

language

2.26

Y

Album

artistId

2.27

Y

Album

artistName

display

2.28

Y

Album

artistName

language

2.28

Y

Album

genre

genreName

2.29

N

Album

genre

subGenreName

2.29

N

Album

contributors

id

2.69

N

Album

contributors

role

2.69

N

Album

contributors

name

2.69

N

Album

discCount

2.30

Y

Album

trackCount

2.31

Y

Album

recordLabel

labelOwnerId

2.32

Y

Album

recordLabel

labelOwnerName

2.32

Y

Album

subRecordLabel

labelOwnerId

2.33

N

Album

subRecordLabel

labelOwnerName

2.33

N

Album

displayLabel

2.34

Y

Album

provisionProducerLine

2.35

N

Album

distFlg

2.36

Y

Album

originalReleaseDate

2.37

Y

Album

rights

startDate

2.38

Y

Album

rights

endDate

2.38

Y

Album

rights

country

2.38

Y

Album

rights

type

2.38

Y

Album

mediaFlg

2.39

Y

Album

explicit

2.40

Y

Album

contentLanguage

2.70

N

Album

custom1

2.41

N

Album

custom2

2.42

N

Album

custom3

2.43

N

Album

custom4

2.44

N

Album

custom5

2.45

N

Album

imageLocation

2.46

N

Track

discNumber

2.47

Y

Track

trackNumber

2.48

Y

Track

trackId

2.49

Y

Track

grid

2.50

N

Track

isrc

2.51

Y

Track

duration

2.52

Y

Track

title

display

2.53

Y

Track

title

language

2.53

Y

Track

artistId

2.54

Y

Track

artistName

display

2.55

Y

Track

artistName

language

2.55

Y

Track

genre

genreName

2.56

Y*

Track

genre

subGenreName

2.56

Y*

Track

distFlg

2.57

Y

Track

displayLabel

2.58

Y

Track

contributors

id

2.69

N

Track

contributors

role

2.69

N

Track

contributors

name

2.69

N

Track

provisionProducerLine

2.59

N

Track

rights

startDate

2.60

Y

Track

rights

endDate

2.60

Y

Track

rights

country

2.60

Y

Track

rights

type

2.60

Y

Track

mediaFlg

2.61

Y

Track

explicit

2.62

Y

Track

audioLocation

2.68

N

Track

contentLanguage

2.71

N

Track

pubRights

2.72

N

Track

custom1

2.63

N

Track

custom2

2.64

N

Track

custom3

2.65

N

Track

custom4

2.66

N

Track

custom5

2.67

N

2.21 releaseId

TunedGlobal`s unique album identifier ID. Use this ID for access to album assets such as artwork (via content delivery API)

FORMAT: ​String

MANDATORY:​

2.22 action

This object will describe the delivery. Options are New, Update or Takedown. Recommended best practice is;

• New Action: Add all metadata to your system as a new item. Best practice is to test for the existence of this ID, even though it is denoted as new.
  • Note that to make an album or track active on your system you must still check the Album Rights (2.38) and Track Rights (2.60) and ensure that you are complying with the startDate to give people access to the asset. Note: This is a critical requirement of your licensing, otherwise you will be in Breach of your agreement.
• Update Action; Treat an update as a New, being to delete the metadata in your system and re-insert as per a New. This includes fetching new objects as they may have been updated by the label.
  • Notes 
    • An update can be a takedown in that the endDate in rights has been updated to be a past, today or future date. You must check these dates and manage the availability of the products on your system. This means that if an endDate is past or today, then the album or track should NOT be available. If it is a future date, you must create a system to make this product unavailable at that time. TUNED will not send through an additional update for this item.
    • To make an album or track active on your system you must still check the Album Rights (2.38) and Track Rights (2.60) and ensure that you are complying with the startDate to give people access to the asset.
    • Rights management is a critical requirement of your licensing, otherwise you will be in Breach of your agreement.
• If an Takedown, you can assume you can remove all the rights to this item immediately and make it unavailable on your system.

I=INSERT (NEW), U=UPDATE, X=TAKEDOWN

FORMAT: ​String

MANDATORY:​ Y

2.23 upc

The UPC that identifies this release. Note that a UPC is not unique, multiple labels may deliver the same UPC. This is for information only, rely on the releaseId as a unique property.

FORMAT: ​String

MANDATORY:​ Y

2.24 grid

The GRID that identifies this release.

FORMAT: ​String

MANDATORY:​ N

2.25 type

Denotes the type of release, Album, Single, EP etc.

FORMAT: ​String

MANDATORY:​ Y

2.26 title

This is an array denoting the title of the album. The array supports multiple languages.

The objects are; 

• display: The Title to display 
• language: denoting the ISO code for the language.

display

FORMAT: ​String

MANDATORY:​ Y

language

FORMAT: ​String (ISO 3166-1 alpha-2)

MANDATORY:​ Y

2.27 artistId

Denotes the artist ID. Use this ID to build your own Artist Data System.

FORMAT: ​String

MANDATORY:​ Y

2.28 artistName

This is an array denoting the name of the artist. The array supports multiple languages.

The objects are; 

• display: The Artist Name to display 
• language: denoting the ISO code for the language.

display

FORMAT: ​String

MANDATORY:​ Y

language

FORMAT: ​String (ISO 3166-1 alpha-2)

MANDATORY:​ Y

2.29 genre

This is an array denoting the genre of the album. The array supports multiple genres.

The objects are; 

• genreName: A primary genre for this album 
• subGenreName: denoting a sub genre to the primary genre.

genreName

FORMAT: ​String

MANDATORY:​ N

subGenreName

FORMAT: ​String

MANDATORY:​ N

2.30 discCount

Denotes number of discs for this Album.

FORMAT: ​Number

MANDATORY:​ Y

2.31 trackCount

Denotes number of tracks for this Album.

FORMAT: ​Number

MANDATORY:​ Y

2.32 recordLabel

This is a parent tag denoting the record label of the album. The objects are; 

• labelOwnerID: This is the TG id of delivering party 
• labelOwnerName: denoting the name of the delivering party.

labelOwnerId

FORMAT: ​Number

MANDATORY:​ Y

labelOwnerName

FORMAT: ​String

MANDATORY:​ Y

2.33 subRecordLabel

This is a parent tag denoting the delivering sub label. This is used where the main delivering party is an aggregator (i.e. Merlin) and the actual label is then the sub record label.

The objects are; 

• labelOwnerID: This is the TG id of delivering party 
• labelOwnerName: denoting the name of the delivering party

labelOwnerId

FORMAT: ​Number

MANDATORY:​ Y

labelOwnerName

FORMAT: ​String

MANDATORY:​ Y

2.34 displayLabel

Display label (eg. LaFace records).

FORMAT: ​String

MANDATORY:​ Y

2.35 provisionProducerLine

C Line for display only

FORMAT: ​String

MANDATORY:​ Y

2.36 distFlg

Denotes general availability of this album for display purposes. Streaming rights are at a track level. 

0 = Album Distribution is available, 1 = Album Distribution is NOT available

FORMAT: ​String

MANDATORY:​ Y

2.37 originalReleaseDate

Denotes original release date of album. If unavailable the release date will be used. 

FORMAT: ​String, yyyy-mm-dd

MANDATORY:​ Y

2.38 rights

This is an array denoting the availability of the album. Granular streaming rights are at a track level. The array supports multiple territories.

The objects are; 

• startDate: the start date for access, sent with UTC offset 
• endDate: the end date for access
• country: the applicable territory in ISO 3166 format(WW denotes worldwide)
• type: the usage type such as streaming or download, streaming is the default.

startDate

FORMAT: ​String, YYYY-MM-DD

MANDATORY:​ Y

endDate

FORMAT: ​String, YYYY-MM-DD

MANDATORY:​ Y

country

FORMAT:​ String, (ISO 3166-1 alpha-2 includes WW)

MANDATORY:​ Y

type

FORMAT: ​String

MANDATORY:​ Y

2.39 mediaFlag

Denotes if the Album is a video or audio album 

1: Audio only

2: Video only

FORMAT: ​Number

MANDATORY:​ Y

2.40 explicit

Denotes if the album contains explicit lyrics 

Options are True or False

FORMAT: ​String

MANDATORY:​ Y

2.41 custom1

Custom field for client (eg. BPM or key). This custom field is currently used to send BPM 

FORMAT: ​String

MANDATORY:​

2.42 custom2

Custom field for client (eg. BPM or key) 

FORMAT: ​String

MANDATORY:​ N

2.43 custom3

Custom field for client (eg. BPM or key) 

FORMAT: ​String

MANDATORY:​ N

2.44 custom4

Custom field for client (eg. BPM or key) 

FORMAT: ​String

MANDATORY:​

2.45 custom5

Custom field for client (eg. BPM or key) 

FORMAT: ​String

MANDATORY:​ N

2.46 imageLocation

No longer used. Use the Content Delivery API to request the asset

FORMAT: ​String

MANDATORY:​ N

2.70 contentLanguage

This denotes the language of the performance. It is only made available if it is explicitly sent through by the Licensor, otherwise this will be NULL

FORMAT: ​String (ISO 639-2 alpha-3)

MANDATORY:​ N

2.47 discNumber

The disc number of this release

FORMAT: ​Number

MANDATORY:​ Y

2.48 trackNumber

The track number of this release. Note if there are 2 discs the numbering will continue as a total track count, not per disc.

FORMAT: ​Number

MANDATORY:​ Y

2.49 trackId

TunedGlobal`s unique track identifier ID. Use this ID for access to track assets such as audio or video files (via content delivery API)

FORMAT: ​String

MANDATORY:​ Y

2.50 grid

The GRID that identifies this track. 

FORMAT: ​String

MANDATORY:​ N

2.51 isrc

The ISRC that identifies this track. Note that an ISRC is not unique, labels may deliver the same ISRC on different albums. This is for information only, rely on the trackId as a unique property.

FORMAT: ​String

MANDATORY:​ Y

2.52 duration

The duration of the track in seconds 

FORMAT: ​Number

MANDATORY:​ Y

2.53 title

This is an array denoting the title of the track. The array supports multiple languages.

The objects are; display: The Title to display and Language: denoting the ISO code for the language.

display

FORMAT: ​String

MANDATORY:​ Y

language

FORMAT: ​String (ISO 3166-1 alpha-2)

MANDATORY:​ Y

2.54 artistID

Denotes the artist ID. Use this ID to build your own Artist Data System.

FORMAT: ​String

MANDATORY:​ Y

2.55 artistName

This is an array denoting the name of the artist. The array supports multiple languages.

The objects are; display: The Artist Name to display and Language: denoting the ISO code for the language.

display

FORMAT: ​String

MANDATORY:​ Y

language

FORMAT: ​String (ISO 3166-1 alpha-2)

MANDATORY:​ Y

2.56 genre

This is an array denoting the genre of the track. The array supports multiple genres.

The objects are; genreName: A primary genre for this album and subGenreName: denoting a sub genre to the primary genre.

genreName

FORMAT: ​String

MANDATORY:​ N

subGenreName

FORMAT: ​String

MANDATORY:​ N

2.57 distFlg

Denotes general availability of this album for display purposes. Streaming rights are at a track level. 

0 = Album Distribution is available, 1 = Album Distribution is NOT available

FORMAT: ​String

MANDATORY:​ Y

2.58 displayLabel

Display label (eg. LaFace records).

FORMAT: ​String

MANDATORY:​ Y

2.59 provisionProducerLine

P Line for display only

FORMAT: ​Number

MANDATORY:​ Y

2.60 rights

This is an array denoting the availability of a track in regards to its Master Rights only (not Publishing Rights). Granular streaming rights are at a track level. The array supports multiple territories and usage types.

The objects are; 

• startDate: the start date for access, sent with UTC offset 
• endDate: the end date for access
• country: the applicable territory in ISO 3166 format (WW denotes worldwide)
• type: the usage type such as streaming or download, streaming is the default.

Dates are formatted as follows:

 YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)

startDate

FORMAT: ​String, YYYY-MM-DDThh:mm:ssTDZ

MANDATORY:​ Y

endDate

FORMAT: ​String, YYYY-MM-DDThh:mm:ssTDZ

MANDATORY:​ Y

country

FORMAT:​ String, (ISO 3166-1 alpha-2 includes WW)

MANDATORY:​ Y

type

FORMAT: ​String

MANDATORY:​ Y

2.61 mediaFlag

Denotes if the Album is a video or audio album 

1: Audio only

2: Video only

FORMAT: ​Number

MANDATORY:​ Y

2.62 explicit

Denotes if the track contains explicit lyrics 

Options are True or False

FORMAT: ​String

MANDATORY:​ Y

2.63 custom1

Custom field for client (Currently used to provide BPM) 

FORMAT: ​String

MANDATORY:​ N

2.64 custom2

Custom field for client (eg. Tag Value, such as mood) 

FORMAT: ​String

MANDATORY:​ N

2.65 custom3

Custom field for client (eg. Tag Value, such as mood) 

FORMAT: ​String

MANDATORY:​ N

2.66 custom4

Custom field for client (eg. Tag Value, such as mood, usually used for LyricFind id, if licensed) 

FORMAT: ​String

MANDATORY:​ N

2.67 custom5

Custom field for client (eg. Tag Value, such as mood) 

FORMAT: ​String

MANDATORY:​ N

2.68 audioLocation

No longer used. Use the Content Delivery API to request the asset

FORMAT: ​String

MANDATORY:​ N

2.69 contributors

This is an array denoting the contributor. The array supports multiple contributors.

The objects are; 

• id: artist id if the name exist in the artist table, else the value will be 0 
• role: contributor role
• name: contributor name

id

FORMAT: ​Number

MANDATORY:​ N

role

FORMAT: ​String

MANDATORY:​ N

name

FORMAT: ​String

MANDATORY:​ N

2.71 contentLanguage

This denotes the language of the performance. It is only made available if it is explicitly sent through by the Licensor, otherwise this will be NULL

FORMAT: ​String (ISO 639-2 alpha-3)

MANDATORY:​ N

2.72 pubRights

This is an array denoting the availability of a track in regards to its Publishing Rights only (not Master Rights). The array supports multiple territories and is only displayed for a territory where it has been denoted that 100% of Publishing Rights are available.

The object within the array is; 

• country: the applicable territory in ISO 3166 format

country

FORMAT:​ String, (ISO 3166-1 alpha-2)

MANDATORY:​ N