/Albums/{albumId}
description
Gets an album data entity. 
url structure
http://localhost/Albums/{albumId}
  • albumId String Album identifier for an album.
action
Get
method
GET
Response
Album object  
Response body
field description
id String Album identifier
UserId String
StatusId Int32 Id of status describing the state of the album
Version Int32 Album version - used to verify that old data will not overwrite newer data
CoverArtUrl String Link to cover art
Comment String Comment supplied by the reviewer
OutletUris IList`1 Collection of store uris
Tracks IList`1 Tracks
Artists IList`1 Artists
Title String Title of album
GenreId Int32 Id of album genre
LanguageId String Id of language, represents the language the album and track metadata is written in
ReleaseDate Nullable`1 Date for release included in the album metadata. Should be supplied in ISO 8601 format. Null = Release ASAP
OriginalReleaseDate Nullable`1 Original release date of album. Should be supplied in ISO 8601 format.
Upc String Album UPC
CatalogNumber String Label Internal CatalogNumber
TracksOrder IList`1 A list of Track id´s belonging to the album, determening the order of the tracks
Territory AlbumTerritory Release territory for the album. Allow : True => the album is allowed to be sold in the specified countries. Allow : False, not allowed to be sold in the specified countries
XactId String
NumberOfTracks Int32 Number of tracks available on album
Status String Status describing state of the album
CreatedDate DateTime Date when the object was first created. Presented in ISO 8601 format.
LastUpdatedDate DateTime Latest date when the object was modified. Presented in ISO 8601 format.
ValidationMessages IEnumerable`1 A list of validation objects containing validation type and validation message of the album.
Response status
200 (OK)  
/Albums/{albumId}
description
Updates an album 
url structure
http://localhost/Albums/{albumId}
  • albumId String
action
PutUpdate
method
PUT
Request body
field description
Title String Title of album
GenreId Nullable`1 Id of album genre
LanguageId String Id of language, represents the language the album and track metadata is written in
ReleaseDate Nullable`1 Date for release included in the album metadata. Should be supplied in ISO 8601 format. Null = Release ASAP
OriginalReleaseDate Nullable`1 Original release date of album. Should be supplied in ISO 8601 format.
Upc String Album UPC
CoverArtUrl String Link to cover art
OutletUris IList`1 Collection of store uris
Tracks IList`1 Tracks
TracksOrder IList`1 Tracks order
Artists IList`1 Artists
CatalogNumber String Label Internal CatalogNumber
Territory AlbumTerritory Release territory for the album. Allow : True => the album is allowed to be sold in the specified countries. Allow : False, not allowed to be sold in the specified countries
XactId String
Response
 
Response body
field description
id String Album identifier
UserId String
StatusId Int32 Id of status describing the state of the album
Version Int32 Album version - used to verify that old data will not overwrite newer data
CoverArtUrl String Link to cover art
Comment String Comment supplied by the reviewer
OutletUris IList`1 Collection of store uris
Tracks IList`1 Tracks
Artists IList`1 Artists
Title String Title of album
GenreId Int32 Id of album genre
LanguageId String Id of language, represents the language the album and track metadata is written in
ReleaseDate Nullable`1 Date for release included in the album metadata. Should be supplied in ISO 8601 format. Null = Release ASAP
OriginalReleaseDate Nullable`1 Original release date of album. Should be supplied in ISO 8601 format.
Upc String Album UPC
CatalogNumber String Label Internal CatalogNumber
TracksOrder IList`1 A list of Track id´s belonging to the album, determening the order of the tracks
Territory AlbumTerritory Release territory for the album. Allow : True => the album is allowed to be sold in the specified countries. Allow : False, not allowed to be sold in the specified countries
XactId String
NumberOfTracks Int32 Number of tracks available on album
Status String Status describing state of the album
CreatedDate DateTime Date when the object was first created. Presented in ISO 8601 format.
LastUpdatedDate DateTime Latest date when the object was modified. Presented in ISO 8601 format.
ValidationMessages IEnumerable`1 A list of validation objects containing validation type and validation message of the album.
Response status
200 (OK)  
/Albums/{albumId}/Approve
description
Set's the album's status to Approved only if the album's current status is Validated 
url structure
http://localhost/Albums/{albumId}/Approve
  • albumId String The Album Identifier
action
PostAlbumStatusApproved
method
POST
Request
The Status Message Request
Request body
field description
UserMessage String Comment for status change if any.
TechnicalMessage String Technical message for status change if any.
Response
A album status message object  
Response body
field description
UserMessage String Comment for status change if any.
TechnicalMessage String Technical message for status change if any.
Response status
200 (OK)  
/Albums/{albumId}/Artists
description
 
url structure
http://localhost/Albums/{albumId}/Artists
  • albumId String
action
GetAlbumArtists
method
GET
Response
All tracks as indexed entities  
Response body
field description
Item AlbumArtistResponse
Response status
200 (OK)  
/Albums/{albumId}/Image
description
Gets the image cover file associated with the album 
url structure
http://localhost/Albums/{albumId}/Image
  • albumId String
action
GetImage
method
GET
Response
Base64 encoded image file  
Response body
field description
Id String File identifier
Value Byte[] File as a byte array
ContentType String File content type
Response status
200 (OK)  
/Albums/{albumId}/Reject
description
Set's the album's status to Rejected only if the album's current status is Validated 
url structure
http://localhost/Albums/{albumId}/Reject
  • albumId String The Album Identifier
action
PostAlbumStatusRejectedAsync
method
POST
Request
The Status Message Request
Request body
field description
UserMessage String Comment for status change if any.
TechnicalMessage String Technical message for status change if any.
Response
A album status message object  
Response body
field description
UserMessage String Comment for status change if any.
TechnicalMessage String Technical message for status change if any.
Response status
200 (OK)  
/Albums/{albumId}/Release
description
Creates a release entity for the album on a given outlet using a given uri. 
url structure
http://localhost/Albums/{albumId}/Release
  • albumId String
action
PostAlbumOutletRelease
method
POST
Request body
field description
ExternalId String
OutletId String
Uri Uri
Response
 
Response body
field description
OutletId String
Uri Uri
Response status
200 (OK)  
/Albums/{albumId}/Releases
description
GET's the releases of the album 
url structure
http://localhost/Albums/{albumId}/Releases
  • albumId String The album id
action
GetAlbumReleases
method
GET
Response
 
Response body
field description
Item OutletUriData
Response status
200 (OK)  
/Albums/{albumId}/Status
description
Set's the albums status to the supplied status request 
url structure
http://localhost/Albums/{albumId}/Status
  • albumId String The Album Identifier
action
PostAlbumStatus
method
POST
Request
The Status Request
Request body
field description
StatusId Int32 Id of status describing the state of the album
UserMessage String Comment for status change if any.
TechnicalMessage String Technical message for status change if any.
Response
A album status object  
Response body
field description
StatusId Int32 Id of status describing the state of the album
UserMessage String Comment for status change if any.
TechnicalMessage String Technical message for status change if any.
Response status
200 (OK)  
/Albums/{albumId}/Statuses
description
Gets the statuses of an album. 
url structure
http://localhost/Albums/{albumId}/Statuses
  • albumId String The Album Identifier
action
GetAlbumStatuses
method
GET
Response
A list of album status objects  
Response body
field description
Item AlbumStatusResponse
Response status
200 (OK)  
/Albums/{albumId}/Tracks
description
 
url structure
http://localhost/Albums/{albumId}/Tracks
  • albumId String
action
GetAlbumTracks
method
GET
Response
All tracks as indexed entities  
Response body
field description
Item TrackResponse
Response status
200 (OK)  
/Albums/{albumId}/User
description
Get's the albums owning user 
url structure
http://localhost/Albums/{albumId}/User
  • albumId String Album identifier for an album.
action
GetUser
method
GET
Response
The owing user id of the album  
Response body
field description
Length Int32
Chars Char
Response status
200 (OK)  
/Albums/{albumId}/Validation
description
Set's the albums validation message to the supplied validation request 
url structure
http://localhost/Albums/{albumId}/Validation
  • albumId String The Album Identifier
action
PostAlbumValidation
method
POST
Request
The Validation Message Request
Request body
field description
ValidationMessages IEnumerable`1 Validation messages for album if any.
Response
A album status object  
Response body
field description
ValidationMessages IEnumerable`1 Validation messages for album if any.
Response status
200 (OK)  
/Albums/{albumId}/Validation
description
Gets the validation messages of an album. 
url structure
http://localhost/Albums/{albumId}/Validation
  • albumId String The Album Identifier
action
GetAlbumValidation
method
GET
Response
A list of album validation objects  
Response body
field description
Response status
200 (OK)  
/Albums/Imports
description
Gets all albums that are ready for import 
url structure
http://localhost/Albums/Imports
action
GetImports
method
GET
Response
List of Album Responses that have status importing  
Response body
field description
Item AlbumResponse
Response status
200 (OK)  
/Albums/Status/{status}?createdDateFrom={createdDateFrom}&createdDateTo={createdDateTo}&lastUpdatedDateFrom={lastUpdatedDateFrom}&lastUpdatedDateTo={lastUpdatedDateTo}
description
Returns a list of album id's that satisfys the supplied query parameters 
url structure
http://localhost/Albums/Status/{status}?createdDateFrom={createdDateFrom}&createdDateTo={createdDateTo}&lastUpdatedDateFrom={lastUpdatedDateFrom}&lastUpdatedDateTo={lastUpdatedDateTo}
  • status String The album status
  • createdDateFrom DateTime The album created from date
  • createdDateTo DateTime The album created to date
  • lastUpdatedDateFrom DateTime The album last updated date from
  • lastUpdatedDateTo DateTime The album last updated date to
action
GetAlbumsByStatus
method
GET
Response
 
Response body
field description
Item String
Response status
200 (OK)  
/Albums/Syncs?daysToInclude={daysToInclude}
description
Gets a list of keys that have statuses that should trigger syncs. 
url structure
http://localhost/Albums/Syncs?daysToInclude={daysToInclude}
  • daysToInclude Int32 Age of albums to include based on lastUpdatedDate.
action
GetKeysForSync
method
GET
Response
List of Album Keys that have syncing statuses  
Response body
field description
Item String
Response status
200 (OK)  
/Albums?idList[0]={idList[0]}&idList[1]={idList[1]}
description
No Documentation Found. 
url structure
http://localhost/Albums?idList[0]={idList[0]}&idList[1]={idList[1]}
  • idList List`1 No Documentation Found.
action
GetAlbumsFromIdList
method
GET
Response
 
Response body
field description
Item AlbumResponse
Response status
200 (OK)  
/Tracks/{trackId}
description
Updates a track 
url structure
http://localhost/Tracks/{trackId}
  • trackId String
action
PutUpdate
method
PUT
Request body
field description
Title String Title of Track
GenreId Nullable`1 Genre identifier for the track
Isrc String Isrc number of track
RecordingVersionId Nullable`1 Recording version identifier of the track (see specific endpoint valid for recording version ids')
ExplicitLyrics Nullable`1 Does the track audio contain explicit content
IsCover Nullable`1 Is the track a cover version
XactId Nullable`1 Internal X5 Track Id
RecordingId Nullable`1 Internal X5 Recording Id
AudioUrl String Url used for prelistening of audio file
LanguageId String Language of the content of the track. Optional, if not included (or null) the LanguageId of the album is used
PreviewStart Nullable`1 Start time of preview. Should be supplied in ISO 8601 format for durations or null if not set. Sub-second precision not supported
Response
 
Response body
field description
Index Int32 Index determine track order on a album (first track is index 0)
id String Track identifier
Title String Title of Track
GenreId Int32 Genre identifier for the track
Isrc String Isrc number of track
RecordingVersionId Int32 Recording version identifier of the track (see specific endpoint valid for recording version ids')
ExplicitLyrics Boolean Does the track audio contain explicit content
IsCover Boolean Is the track a cover version
FileName String Original filename of uploaded audiofile
XactId Int32 Id from the Xact database
RecordingId Int32 Recording id from the Xact database
AlbumId String Track album id
Version Int32 Version number of given track
AudioUrl String Url used for prelistening of audio file
Artists IList`1 List of track artists
LanguageId String Language of the content of the track. Optional, if not included (or null) the LanguageId of the album is used
PreviewStart Nullable`1 Start time of preview. In ISO 8601 format for durations
Response status
200 (OK)  
/Tracks/{trackId}/Artists
description
 
url structure
http://localhost/Tracks/{trackId}/Artists
  • trackId String
action
GetTrackArtists
method
GET
Response
All tracks as indexed entities  
Response body
field description
Item TrackArtistResponse
Response status
200 (OK)  
/Tracks/{trackId}/Audio
description
Get's the audiofile associated with the track 
url structure
http://localhost/Tracks/{trackId}/Audio
  • trackId String
action
GetAudioFile
method
GET
Response
Base64 encoded audio file  
Response body
field description
Id String File identifier
Value Byte[] File as a byte array
ContentType String File content type
Response status
200 (OK)  
/Users/{userId}
description
Gets a user using the id supplied 
url structure
http://localhost/Users/{userId}
  • userId String
action
Get
method
GET
Response
The user response object  
Response body
field description
id String User identifier
DistributorRoyaltyPercentageFee Nullable`1 A royalty percentage fee between 0 and 100 that the distributor keeps
UserName String Fiendly username of user
FirstName String First name of user
LastName String Last name of user
Email String E-mail address to user
Region String What region is the user affilated to, ISO 3166-1 alpha-2 country code
LabelName String Name of label associated with user
ExternalId String External identifier, e.g. Auth0 user id
CreatedDate DateTime Date when the object was first created. Presented in ISO 8601 format.
LastUpdatedDate DateTime Latest date when the object was modified. Presented in ISO 8601 format.
Response status
200 (OK)  
/Users/{userId}
description
Delete a user 
url structure
http://localhost/Users/{userId}
  • userId String User identifier
action
Delete
method
DELETE
Response
The user response object  
Response status
202 (Accepted)