X5 Delivery API Developer Documentation ()

/Albums

description

Get a list of album responses from a list of album id's

url structure

http://localhost/Albums

action

PostRetrieveAlbumsFromIdList

method

POST

Request

The filter

Request body

field	description
`Identifiers`	IList`1

{
  "Identifiers": [
    "NP1ZB2JL3VX4NP5NP6CE7RT8TV9BD0JL1RT2",
    "ABCDEFGHIJKLMNOPQRSTUVXYZADSADSZZZ",
    "ABCDEFHHGHIJKLMNOPQRSTUVXYZ123AADD",
    "1337QWERTYQWERTY1234567890999"
  ]
}

Response

Response body

field	description
`Item`	AlbumDetailedResponse

[
  {
    "Artists": [
      {
        "id": "aefc2ebd-79ab-496b-85aa-69764...",
        "ArtistRelationTypeId": 1,
        "ArtistName": "Kalle Karlsson"
      },
      {
        "id": "4d002dc4-4914-43d7-a60d-4aa6...",
        "ArtistRelationTypeId": 1,
        "ArtistName": "Sven Svensson"
      }
    ],
    "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
    "UserId": null,
    "StatusId": 20,
    "Version": 1,
    "CoverArtUrl": "http://cover...usic.com/?file=X517530.jpg",
    "Comment": "A simple comment",
    "OutletUris": [],
    "Tracks": [],
    "Title": "Memphis Blues",
    "GenreId": 26,
    "LanguageId": null,
    "ReleaseDate": "2009-09-17T00:00:00",
    "OriginalReleaseDate": null,
    "Upc": "7340050458923",
    "CatalogNumber": null,
    "TracksOrder": [],
    "Territory": {
      "Allowed": true,
      "CountryCodes": "SE,MX,US"
    },
    "XactId": null,
    "NumberOfTracks": 0,
    "Status": "Validated",
    "CreatedDate": "0001-01-01T00:00:00",
    "LastUpdatedDate": "0001-01-01T00:00:00",
    "ValidationMessages": []
  },
  {
    "Artists": [
      {
        "id": "aefc2ebd-79ab-496b-85aa-69764...",
        "ArtistRelationTypeId": 1,
        "ArtistName": "Kalle Karlsson"
      },
      {
        "id": "4d002dc4-4914-43d7-a60d-4aa6...",
        "ArtistRelationTypeId": 1,
        "ArtistName": "Sven Svensson"
      }
    ],
    "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
    "UserId": null,
    "StatusId": 20,
    "Version": 1,
    "CoverArtUrl": "http://cover...usic.com/?file=X517530.jpg",
    "Comment": "A simple comment",
    "OutletUris": [],
    "Tracks": [],
    "Title": "Memphis Blues",
    "GenreId": 26,
    "LanguageId": null,
    "ReleaseDate": "2009-09-17T00:00:00",
    "OriginalReleaseDate": null,
    "Upc": "7340050458923",
    "CatalogNumber": null,
    "TracksOrder": [],
    "Territory": {
      "Allowed": true,
      "CountryCodes": "SE,MX,US"
    },
    "XactId": null,
    "NumberOfTracks": 0,
    "Status": "Validated",
    "CreatedDate": "0001-01-01T00:00:00",
    "LastUpdatedDate": "0001-01-01T00:00:00",
    "ValidationMessages": []
  }
]

Response status

200 (OK)

/Albums/Status/{status}?userId={userId}&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}?userId={userId}&createdDateFrom={createdDateFrom}&createdDateTo={createdDateTo}&lastUpdatedDateFrom={lastUpdatedDateFrom}&lastUpdatedDateTo={lastUpdatedDateTo}

status String The album status
userId String The user id
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)

/ArtistRelations

description

Get all artist relations available e g featuring

url structure

http://localhost/ArtistRelations

action

Get

method

GET

Response

List of artist relation objects

Response body

field	description
`Item`	ArtistRelationResponse

[
  {
    "Id": "1",
    "Name": "Primary Performer"
  },
  {
    "Id": "12",
    "Name": "Featuring"
  }
]

Response status

200 (OK)

/Countries

description

Get a list of Countries. Supports OData query paramters described here :

url structure

http://localhost/Countries

action

Get

method

GET

Response

Response body

field	description
`Item`	CountryResponse

[
  {
    "Id": "US",
    "CountryCode": "US",
    "CountryName": "United States of America"
  },
  {
    "Id": "AZ",
    "CountryCode": "AZ",
    "CountryName": "Azerbaijan"
  }
]

Response status

200 (OK)

/Genres

description

Get all genres available.

url structure

http://localhost/Genres

action

Get

method

GET

Response

List of genre objects

Response body

field	description
`Item`	GenreResponse

[
  {
    "Id": "2f3fs3g-663-4sd8-cf43ef",
    "Name": "Classical"
  },
  {
    "Id": "892d49adb-28a1-41e5-8daf-5e...",
    "Name": "Pop"
  }
]

Response status

200 (OK)

/Languages

description

Gets all available languages Supports OData query paramters described here :

url structure

http://localhost/Languages

action

Get

method

GET

Response

List of language objects

Response body

field	description
`Item`	LanguageResponse

[
  {
    "Id": "SV",
    "LanguageCode": "SV",
    "LanguageName": "Swedish"
  },
  {
    "Id": null,
    "LanguageCode": "EN",
    "LanguageName": "English"
  }
]

Response status

200 (OK)

/Outlets

description

Get all outlets available.

url structure

http://localhost/Outlets

action

Get

method

GET

Response

List of outlet objects

Response body

field	description
`Item`	OutletResponse

[
  {
    "Id": "1",
    "Name": "Itunes"
  },
  {
    "Id": "28",
    "Name": "Spotify"
  }
]

Response status

200 (OK)

/RecordingVersions

description

Get all recording versions available.

url structure

http://localhost/RecordingVersions

action

Get

method

GET

Response

List of recording versions objects

Response body

field	description
`Item`	RecordingVersionResponse

[
  {
    "Id": "2430",
    "Name": "Original"
  },
  {
    "Id": "2414",
    "Name": "Live"
  }
]

Response status

200 (OK)

/Tracks

description

Get a list of track responses from a list of track id's

url structure

http://localhost/Tracks

action

PostReceiveTracksFromIdList

method

POST

Request

The Filter

Request body

field	description
`Identifiers`	IList`1

{
  "Identifiers": [
    "NP1ZB2JL3VX4NP5NP6CE7RT8TV9BD0JL1RT2",
    "ABCDEFGHIJKLMNOPQRSTUVXYZADSADSZZZ",
    "ABCDEFHHGHIJKLMNOPQRSTUVXYZ123AADD",
    "1337QWERTYQWERTY1234567890999"
  ]
}

Response

Response body

field	description
`Item`	TrackDetailedResponse

[
  {
    "Artists": [
      {
        "id": "02af85c822a8fe333e3b-6b...",
        "TrackId": null,
        "ArtistRelationTypeId": 1,
        "ArtistName": "Adolf Eriksson"
      },
      {
        "id": "02af85c822a8fe333e3b-6b...",
        "TrackId": null,
        "ArtistRelationTypeId": 1,
        "ArtistName": "Adolf Eriksson"
      }
    ],
    "Index": 2,
    "id": "936da01f-9abd-4d9d-80c7-02af85c82...",
    "Title": "My first track",
    "GenreId": 26,
    "Isrc": null,
    "RecordingVersionId": 2430,
    "ExplicitLyrics": false,
    "IsCover": false,
    "FileName": null,
    "XactId": 0,
    "RecordingId": 0,
    "AlbumId": null,
    "Version": 123,
    "AudioUrl": "http://prelis...usic.com/?file=245945.mp3",
    "LanguageId": "en",
    "PreviewStart": "PT1M24S"
  },
  {
    "Artists": [
      {
        "id": "02af85c822a8fe333e3b-6b...",
        "TrackId": null,
        "ArtistRelationTypeId": 1,
        "ArtistName": "Adolf Eriksson"
      },
      {
        "id": "02af85c822a8fe333e3b-6b...",
        "TrackId": null,
        "ArtistRelationTypeId": 1,
        "ArtistName": "Adolf Eriksson"
      }
    ],
    "Index": 2,
    "id": "936da01f-9abd-4d9d-80c7-02af85c82...",
    "Title": "My first track",
    "GenreId": 26,
    "Isrc": null,
    "RecordingVersionId": 2430,
    "ExplicitLyrics": false,
    "IsCover": false,
    "FileName": null,
    "XactId": 0,
    "RecordingId": 0,
    "AlbumId": null,
    "Version": 123,
    "AudioUrl": "http://prelis...usic.com/?file=245945.mp3",
    "LanguageId": "en",
    "PreviewStart": "PT1M24S"
  }
]

Response status

200 (OK)

/Users

description

Create a user.

url structure

http://localhost/Users

action

Post

method

POST

Request

User object to create

Request body

field	description
`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.

{
  "UserName": "user2",
  "FirstName": "User",
  "LastName": "Two",
  "Email": "user2@example.com",
  "Region": null,
  "LabelName": null,
  "ExternalId": null
}

Response

Created user 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.

{
  "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
  "DistributorRoyaltyPercentageFee": null,
  "UserName": "user1",
  "FirstName": "User",
  "LastName": "One",
  "Email": "user1@example.com",
  "Region": null,
  "LabelName": null,
  "ExternalId": null,
  "CreatedDate": "2025-06-09T23:47:33.2235036Z",
  "LastUpdatedDate": "2025-06-09T23:47:33.2235036Z"
}

Response status

201 (Created)

/Users/{userId}

description

Get a user.

url structure

http://localhost/Users/{userId}

userId String User identifier.

action

Get

method

GET

Response

User 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.

{
  "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
  "DistributorRoyaltyPercentageFee": null,
  "UserName": "user1",
  "FirstName": "User",
  "LastName": "One",
  "Email": "user1@example.com",
  "Region": null,
  "LabelName": null,
  "ExternalId": null,
  "CreatedDate": "2025-06-09T23:47:33.2235036Z",
  "LastUpdatedDate": "2025-06-09T23:47:33.2235036Z"
}

Response status

200 (OK)

/Users/{userId}

description

Update an user.

url structure

http://localhost/Users/{userId}

userId String User identifier for the user to update.

action

PutUpdate

method

PUT

Request

User object with changes

Request body

field	description
`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.

{
  "UserName": "user2",
  "FirstName": "User",
  "LastName": "Two",
  "Email": "user2@example.com",
  "Region": null,
  "LabelName": null,
  "ExternalId": null
}

Response

Updated user 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.

{
  "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
  "DistributorRoyaltyPercentageFee": null,
  "UserName": "user1",
  "FirstName": "User",
  "LastName": "One",
  "Email": "user1@example.com",
  "Region": null,
  "LabelName": null,
  "ExternalId": null,
  "CreatedDate": "2025-06-09T23:47:33.2235036Z",
  "LastUpdatedDate": "2025-06-09T23:47:33.2235036Z"
}

Response status

200 (OK)

/Users/{userId}

description

No Documentation Found.

url structure

http://localhost/Users/{userId}

userId String No Documentation Found.

action

Patch

method

PATCH

Request

No Documentation Found.

Request body

field	description
`Operations`	List`1

Response

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.

{
  "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
  "DistributorRoyaltyPercentageFee": null,
  "UserName": "user1",
  "FirstName": "User",
  "LastName": "One",
  "Email": "user1@example.com",
  "Region": null,
  "LabelName": null,
  "ExternalId": null,
  "CreatedDate": "2025-06-09T23:47:33.2235036Z",
  "LastUpdatedDate": "2025-06-09T23:47:33.2235036Z"
}

Response status

200 (OK)

/Users/{userId}/Albums

description

Create an album.

url structure

http://localhost/Users/{userId}/Albums

userId String The User Identifier

action

PostCreate

method

POST

Request

The Album Request

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
`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

{
  "Title": "Memphis Blues",
  "GenreId": 26,
  "LanguageId": null,
  "ReleaseDate": "2009-09-17T00:00:00",
  "OriginalReleaseDate": null,
  "Upc": null,
  "Territory": {
    "Allowed": true,
    "CountryCodes": "SE,DE,FR,AZ,BE,AU,ES,UK"
  }
}

Response

Created album object

Response body

field	description
`Artists`	IEnumerable`1 The Artists of the Album
`id`	String Album identifier
`UserId`	String
`StatusId`	Int32 Id of status describing the state of the album NotCompleted = 0AdminEdit = 5Importing = 10Validated = 20Approved = 30Delivered = 40AwaitingTakedown = 50TakedownCompleted = 60Live = 70Rejected = 90Deleted = 99BeforeCreated = -1
`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.

{
  "Artists": [
    {
      "id": "aefc2ebd-79ab-496b-85aa-69764...",
      "ArtistRelationTypeId": 1,
      "ArtistName": "Kalle Karlsson"
    },
    {
      "id": "4d002dc4-4914-43d7-a60d-4aa6...",
      "ArtistRelationTypeId": 1,
      "ArtistName": "Sven Svensson"
    }
  ],
  "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
  "UserId": null,
  "StatusId": 20,
  "Version": 1,
  "CoverArtUrl": "http://cover...usic.com/?file=X517530.jpg",
  "Comment": "A simple comment",
  "OutletUris": [],
  "Tracks": [],
  "Title": "Memphis Blues",
  "GenreId": 26,
  "LanguageId": null,
  "ReleaseDate": "2009-09-17T00:00:00",
  "OriginalReleaseDate": null,
  "Upc": "7340050458923",
  "CatalogNumber": null,
  "TracksOrder": [],
  "Territory": {
    "Allowed": true,
    "CountryCodes": "SE,MX,US"
  },
  "XactId": null,
  "NumberOfTracks": 0,
  "Status": "Validated",
  "CreatedDate": "0001-01-01T00:00:00",
  "LastUpdatedDate": "0001-01-01T00:00:00",
  "ValidationMessages": []
}

Response status

201 (Created)

/Users/{userId}/Albums/{albumId}

description

Gets an album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}

userId String The User Indentifier
albumId String Album identifier for an album.

action

Get

method

GET

Response

Album object

Response body

field	description
`Artists`	IEnumerable`1 The Artists of the Album
`id`	String Album identifier
`UserId`	String
`StatusId`	Int32 Id of status describing the state of the album NotCompleted = 0AdminEdit = 5Importing = 10Validated = 20Approved = 30Delivered = 40AwaitingTakedown = 50TakedownCompleted = 60Live = 70Rejected = 90Deleted = 99BeforeCreated = -1
`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.

{
  "Artists": [
    {
      "id": "aefc2ebd-79ab-496b-85aa-69764...",
      "ArtistRelationTypeId": 1,
      "ArtistName": "Kalle Karlsson"
    },
    {
      "id": "4d002dc4-4914-43d7-a60d-4aa6...",
      "ArtistRelationTypeId": 1,
      "ArtistName": "Sven Svensson"
    }
  ],
  "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
  "UserId": null,
  "StatusId": 20,
  "Version": 1,
  "CoverArtUrl": "http://cover...usic.com/?file=X517530.jpg",
  "Comment": "A simple comment",
  "OutletUris": [],
  "Tracks": [],
  "Title": "Memphis Blues",
  "GenreId": 26,
  "LanguageId": null,
  "ReleaseDate": "2009-09-17T00:00:00",
  "OriginalReleaseDate": null,
  "Upc": "7340050458923",
  "CatalogNumber": null,
  "TracksOrder": [],
  "Territory": {
    "Allowed": true,
    "CountryCodes": "SE,MX,US"
  },
  "XactId": null,
  "NumberOfTracks": 0,
  "Status": "Validated",
  "CreatedDate": "0001-01-01T00:00:00",
  "LastUpdatedDate": "0001-01-01T00:00:00",
  "ValidationMessages": []
}

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}

description

Update an album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}

userId String User identifier
albumId String Album identifier for album to update.

action

PutUpdate

method

PUT

Request

Album object that was updated

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
`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

{
  "Title": "Memphis Blues",
  "GenreId": 26,
  "LanguageId": null,
  "ReleaseDate": "2009-09-17T00:00:00",
  "OriginalReleaseDate": null,
  "Upc": null,
  "Territory": {
    "Allowed": true,
    "CountryCodes": "SE,DE,FR,AZ,BE,AU,ES,UK"
  }
}

Response

Updated album object

Response body

field	description
`Artists`	IEnumerable`1 The Artists of the Album
`id`	String Album identifier
`UserId`	String
`StatusId`	Int32 Id of status describing the state of the album NotCompleted = 0AdminEdit = 5Importing = 10Validated = 20Approved = 30Delivered = 40AwaitingTakedown = 50TakedownCompleted = 60Live = 70Rejected = 90Deleted = 99BeforeCreated = -1
`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.

{
  "Artists": [
    {
      "id": "aefc2ebd-79ab-496b-85aa-69764...",
      "ArtistRelationTypeId": 1,
      "ArtistName": "Kalle Karlsson"
    },
    {
      "id": "4d002dc4-4914-43d7-a60d-4aa6...",
      "ArtistRelationTypeId": 1,
      "ArtistName": "Sven Svensson"
    }
  ],
  "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
  "UserId": null,
  "StatusId": 20,
  "Version": 1,
  "CoverArtUrl": "http://cover...usic.com/?file=X517530.jpg",
  "Comment": "A simple comment",
  "OutletUris": [],
  "Tracks": [],
  "Title": "Memphis Blues",
  "GenreId": 26,
  "LanguageId": null,
  "ReleaseDate": "2009-09-17T00:00:00",
  "OriginalReleaseDate": null,
  "Upc": "7340050458923",
  "CatalogNumber": null,
  "TracksOrder": [],
  "Territory": {
    "Allowed": true,
    "CountryCodes": "SE,MX,US"
  },
  "XactId": null,
  "NumberOfTracks": 0,
  "Status": "Validated",
  "CreatedDate": "0001-01-01T00:00:00",
  "LastUpdatedDate": "0001-01-01T00:00:00",
  "ValidationMessages": []
}

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}

description

No Documentation Found.

url structure

http://localhost/Users/{userId}/Albums/{albumId}

userId String No Documentation Found.
albumId String No Documentation Found.

action

Patch

method

PATCH

Request

No Documentation Found.

Request body

field	description
`Operations`	List`1

[
  {
    "value": "Test",
    "path": "/title",
    "op": "replace"
  },
  {
    "value": "123456789",
    "path": "/upc",
    "op": "replace"
  }
]

Response

Response body

field	description
`Artists`	IEnumerable`1 The Artists of the Album
`id`	String Album identifier
`UserId`	String
`StatusId`	Int32 Id of status describing the state of the album NotCompleted = 0AdminEdit = 5Importing = 10Validated = 20Approved = 30Delivered = 40AwaitingTakedown = 50TakedownCompleted = 60Live = 70Rejected = 90Deleted = 99BeforeCreated = -1
`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.

{
  "Artists": [
    {
      "id": "aefc2ebd-79ab-496b-85aa-69764...",
      "ArtistRelationTypeId": 1,
      "ArtistName": "Kalle Karlsson"
    },
    {
      "id": "4d002dc4-4914-43d7-a60d-4aa6...",
      "ArtistRelationTypeId": 1,
      "ArtistName": "Sven Svensson"
    }
  ],
  "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
  "UserId": null,
  "StatusId": 20,
  "Version": 1,
  "CoverArtUrl": "http://cover...usic.com/?file=X517530.jpg",
  "Comment": "A simple comment",
  "OutletUris": [],
  "Tracks": [],
  "Title": "Memphis Blues",
  "GenreId": 26,
  "LanguageId": null,
  "ReleaseDate": "2009-09-17T00:00:00",
  "OriginalReleaseDate": null,
  "Upc": "7340050458923",
  "CatalogNumber": null,
  "TracksOrder": [],
  "Territory": {
    "Allowed": true,
    "CountryCodes": "SE,MX,US"
  },
  "XactId": null,
  "NumberOfTracks": 0,
  "Status": "Validated",
  "CreatedDate": "0001-01-01T00:00:00",
  "LastUpdatedDate": "0001-01-01T00:00:00",
  "ValidationMessages": []
}

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}

description

Delete an album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}

userId String User identifier
albumId String Album identifier for album to delete.

action

Delete

method

DELETE

Response

Empty response

Response status

202 (Accepted)

/Users/{userId}/Albums/{albumId}/Artists

description

Get artists for the specified album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Artists

userId String User identifier
albumId String Album identifier

action

Get

method

GET

Response

List of AlbumArtist objects

Response body

field	description
`Item`	AlbumArtistResponse

[
  {
    "id": "aefc2ebd-79ab-496b-85aa-69764...",
    "ArtistRelationTypeId": 1,
    "ArtistName": "Kalle Karlsson"
  },
  {
    "id": "4d002dc4-4914-43d7-a60d-4aa6...",
    "ArtistRelationTypeId": 1,
    "ArtistName": "Sven Svensson"
  }
]

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}/Artists

description

Create an artist for an album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Artists

userId String User identifier
albumId String Album identifier

action

Post

method

POST

Request

Album artist object to create

Request body

field	description
`ArtistRelationTypeId`	Int32 Artist relation type identifier
`ArtistName`	String Artist name

{
  "ArtistRelationTypeId": 1,
  "ArtistName": "Kalle Karlsson"
}

Response

The created album artist object.

Response body

field	description
`id`	String The id of the artist
`AlbumId`	String Album identifier
`ArtistRelationTypeId`	Int32 Artist relation type identifier
`ArtistName`	String Artist name

{
  "id": "aefc2ebd-79ab-496b-85aa-69764...",
  "ArtistRelationTypeId": 1,
  "ArtistName": "Kalle Karlsson"
}

Response status

201 (Created)

/Users/{userId}/Albums/{albumId}/Artists/{artistId}

description

Update an artist for an album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Artists/{artistId}

userId String User identifier
albumId String Album indentifier
artistId String Album Level Artist Identifier

action

Put

method

PUT

Request

Album artist object to update

Request body

field	description
`ArtistRelationTypeId`	Int32 Artist relation type identifier
`ArtistName`	String Artist name

{
  "ArtistRelationTypeId": 1,
  "ArtistName": "Kalle Karlsson"
}

Response

The updated album artist object.

Response body

field	description
`id`	String The id of the artist
`AlbumId`	String Album identifier
`ArtistRelationTypeId`	Int32 Artist relation type identifier
`ArtistName`	String Artist name

{
  "id": "aefc2ebd-79ab-496b-85aa-69764...",
  "ArtistRelationTypeId": 1,
  "ArtistName": "Kalle Karlsson"
}

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}/Artists/{artistId}

description

Delete an artist from the album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Artists/{artistId}

userId String User identifier
albumId String Album identifier
artistId String Album artist identifier

action

Delete

method

DELETE

Response

Empty response

Response status

204 (NoContent)

/Users/{userId}/Albums/{albumId}/AudioFileStatus

description

Gets all track audio file statuses for the resource (album)

url structure

http://localhost/Users/{userId}/Albums/{albumId}/AudioFileStatus

userId String The user Id
albumId String

action

GetTrackFileStatuses

method

GET

Response

List of filestatuses

Response body

field	description
`Item`	FileUploadStatusResponse

[
  {
    "ResourceId": null,
    "id": "12389128341928312",
    "ContentType": "audio/flac",
    "Uri": "covers:x5music:12389128341928312",
    "Status": 20,
    "FileType": 0,
    "Message": null
  },
  {
    "ResourceId": null,
    "id": "12389128341928312",
    "ContentType": "audio/flac",
    "Uri": "covers:x5music:12389128341928312",
    "Status": 20,
    "FileType": 0,
    "Message": null
  }
]

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}/CoverAsync

description

Upload an image and attaches it to an album (overwrites old image one already exists). The file is attached as file form-data in the body. Content-Type: multipart/form-data The image must be quadratic with the minimum resoltion of 1400 px x 1400 px.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/CoverAsync

userId String User identifier
albumId String Album identifier for album to upload cover art to

action

PostUpload

method

POST

Response

Empty response

Response body

field	description
`ResourceId`	String
`id`	String
`ContentType`	String
`Uri`	Uri
`Status`	Int32 NotCompleted = 0Processing = 10Completed = 20Incomplete = 98Error = 99
`FileType`	Int32 Source = 0AudioLow = 1ImageExtraSmall = 2ImageSmall = 3ImageMedium = 4ImageLarge = 5ImageExtraLarge = 6
`Message`	String
`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.

{
  "ResourceId": null,
  "id": "12389128341928312",
  "ContentType": "audio/flac",
  "Uri": "covers:x5music:12389128341928312",
  "Status": 20,
  "FileType": 0,
  "Message": null
}

Response status

201 (Created)

/Users/{userId}/Albums/{albumId}/FileStatus

description

Gets all file statuses for the resource (album)

url structure

http://localhost/Users/{userId}/Albums/{albumId}/FileStatus

userId String The user Id
albumId String The Album id

action

GetFileStatuses

method

GET

Response

List of filestatuses

Response body

field	description
`Item`	FileUploadStatusResponse

[
  {
    "ResourceId": null,
    "id": "12389128341928312",
    "ContentType": "audio/flac",
    "Uri": "covers:x5music:12389128341928312",
    "Status": 20,
    "FileType": 0,
    "Message": null
  },
  {
    "ResourceId": null,
    "id": "12389128341928312",
    "ContentType": "audio/flac",
    "Uri": "covers:x5music:12389128341928312",
    "Status": 20,
    "FileType": 0,
    "Message": null
  }
]

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}/Release

description

Request release of an album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Release

userId String User identifier
albumId String Album identifier for album to request release for

action

PostAsync

method

POST

Response

Empty response

Response status

204 (NoContent)

/Users/{userId}/Albums/{albumId}/Releases

description

Get releases of an album. Supports OData query paramters described here :

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Releases

userId String User identifier
albumId String Album identifier for getting releases for

action

Get

method

GET

Response

List of releases

Response body

field	description
`Item`	OutletUriBase

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}/Statuses

description

Get all statuses for an album. Supports OData query paramters described here :

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Statuses

userId String
albumId String Album identifier for which to get statuses for

action

Get

method

GET

Response

List of album status objects

Response body

field	description
`Item`	AlbumStatusResponse

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}/StoreTitle

description

Gets the album store title.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/StoreTitle

userId String The User Indentifier
albumId String Album identifier for an album.

action

GetStoreTitle

method

GET

Response

Album object

Response body

field	description
`FullTitle`	String Complete title with version and artists
`VersionPart`	String Only version and artists
`TitlePart`	String Only title

{
  "FullTitle": "My Title (feat. Jazzy J) [Live]",
  "VersionPart": "(feat. Jazzy J) [Live]",
  "TitlePart": "My Title"
}

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}/Takedown

description

Request takedown of an album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Takedown

userId String User identifier
albumId String Album identifier for album to request for takedown from outlet

action

PostInitiate

method

POST

Response

Empty response

Response status

204 (NoContent)

/Users/{userId}/Albums/{albumId}/Tracks

description

Get all tracks for an album.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Tracks

userId String User identifier
albumId String Album identifier for which to get tracks for

action

GetTracks

method

GET

Response

List of track objects

Response body

field	description
`Item`	TrackDetailedResponse

[
  {
    "Artists": [
      {
        "id": "02af85c822a8fe333e3b-6b...",
        "TrackId": null,
        "ArtistRelationTypeId": 1,
        "ArtistName": "Adolf Eriksson"
      },
      {
        "id": "02af85c822a8fe333e3b-6b...",
        "TrackId": null,
        "ArtistRelationTypeId": 1,
        "ArtistName": "Adolf Eriksson"
      }
    ],
    "Index": 2,
    "id": "936da01f-9abd-4d9d-80c7-02af85c82...",
    "Title": "My first track",
    "GenreId": 26,
    "Isrc": null,
    "RecordingVersionId": 2430,
    "ExplicitLyrics": false,
    "IsCover": false,
    "FileName": null,
    "XactId": 0,
    "RecordingId": 0,
    "AlbumId": null,
    "Version": 123,
    "AudioUrl": "http://prelis...usic.com/?file=245945.mp3",
    "LanguageId": "en",
    "PreviewStart": "PT1M24S"
  },
  {
    "Artists": [
      {
        "id": "02af85c822a8fe333e3b-6b...",
        "TrackId": null,
        "ArtistRelationTypeId": 1,
        "ArtistName": "Adolf Eriksson"
      },
      {
        "id": "02af85c822a8fe333e3b-6b...",
        "TrackId": null,
        "ArtistRelationTypeId": 1,
        "ArtistName": "Adolf Eriksson"
      }
    ],
    "Index": 2,
    "id": "936da01f-9abd-4d9d-80c7-02af85c82...",
    "Title": "My first track",
    "GenreId": 26,
    "Isrc": null,
    "RecordingVersionId": 2430,
    "ExplicitLyrics": false,
    "IsCover": false,
    "FileName": null,
    "XactId": 0,
    "RecordingId": 0,
    "AlbumId": null,
    "Version": 123,
    "AudioUrl": "http://prelis...usic.com/?file=245945.mp3",
    "LanguageId": "en",
    "PreviewStart": "PT1M24S"
  }
]

Response status

200 (OK)

/Users/{userId}/Albums/{albumId}/Tracks

description

Create a new track for a specific createdAlbum. Tracks must belong to an Album - the Album needs to be created before a track can be added.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Tracks

userId String User identifier
albumId String Album identifier for which to add the track

action

Post

method

POST

Request

Parts of new track object including album identifier

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
`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

{
  "Title": "My best track",
  "GenreId": 26,
  "Isrc": null,
  "RecordingVersionId": 2430,
  "ExplicitLyrics": null,
  "IsCover": null,
  "LanguageId": null,
  "PreviewStart": null
}

Response

Created track object

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

{
  "Index": 2,
  "id": "936da01f-9abd-4d9d-80c7-02af85c82...",
  "Title": "My first track",
  "GenreId": 26,
  "Isrc": null,
  "RecordingVersionId": 2430,
  "ExplicitLyrics": false,
  "IsCover": false,
  "FileName": null,
  "XactId": 0,
  "RecordingId": 0,
  "AlbumId": null,
  "Version": 123,
  "AudioUrl": "http://prelis...usic.com/?file=245945.mp3",
  "Artists": [],
  "LanguageId": "en",
  "PreviewStart": "PT1M24S"
}

Response status

201 (Created)

/Users/{userId}/Albums/{albumId}/Tracks/Init

description

Initiate a new track for a specific createdAlbum. Tracks must belong to an Album - the Album needs to be created before a track can be added.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/Tracks/Init

userId String User identifier
albumId String Album identifier for which to add the track

action

Post

method

POST

Request body

field	description
`TrackFileNames`	String[]

Response

Created track object

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

{
  "Index": 2,
  "id": "936da01f-9abd-4d9d-80c7-02af85c82...",
  "Title": "My first track",
  "GenreId": 26,
  "Isrc": null,
  "RecordingVersionId": 2430,
  "ExplicitLyrics": false,
  "IsCover": false,
  "FileName": null,
  "XactId": 0,
  "RecordingId": 0,
  "AlbumId": null,
  "Version": 123,
  "AudioUrl": "http://prelis...usic.com/?file=245945.mp3",
  "Artists": [],
  "LanguageId": "en",
  "PreviewStart": "PT1M24S"
}

Response status

201 (Created)

/Users/{userId}/Albums/{albumId}/TracksOrder

description

Update track order.

url structure

http://localhost/Users/{userId}/Albums/{albumId}/TracksOrder

userId String User identifier
albumId String Album identifier for album to update.

action

UpdateTrackOrder

method

PUT

Request

List of the desired track order

Request body

field	description
`TracksOrder`	IReadOnlyList`1

Response

Updated album object

Response body

field	description
`TracksOrder`	String[]

Response status

200 (OK)

/Users/{userId}/Albums/Init

description

Create an empty album with empty tracks.

url structure

http://localhost/Users/{userId}/Albums/Init

userId String The User Identifier

action

PostCreate

method

POST

Request

The Album Request

Request body

field	description
`TrackFileNames`	String[]

Response

Created album object

Response status

201 (Created)

/Users/{userId}/Albums?includeDeleted={includeDeleted}

description

Get all albums for the user specified in header. Supports OData query paramters described here :

url structure

http://localhost/Users/{userId}/Albums?includeDeleted={includeDeleted}

userId String The User Identifier
includeDeleted Boolean Include deleted albums. Default is false.

action

GetAlbums

method

GET

Response

Response body

field	description
`Item`	AlbumDetailedResponse

[
  {
    "Artists": [
      {
        "id": "aefc2ebd-79ab-496b-85aa-69764...",
        "ArtistRelationTypeId": 1,
        "ArtistName": "Kalle Karlsson"
      },
      {
        "id": "4d002dc4-4914-43d7-a60d-4aa6...",
        "ArtistRelationTypeId": 1,
        "ArtistName": "Sven Svensson"
      }
    ],
    "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
    "UserId": null,
    "StatusId": 20,
    "Version": 1,
    "CoverArtUrl": "http://cover...usic.com/?file=X517530.jpg",
    "Comment": "A simple comment",
    "OutletUris": [],
    "Tracks": [],
    "Title": "Memphis Blues",
    "GenreId": 26,
    "LanguageId": null,
    "ReleaseDate": "2009-09-17T00:00:00",
    "OriginalReleaseDate": null,
    "Upc": "7340050458923",
    "CatalogNumber": null,
    "TracksOrder": [],
    "Territory": {
      "Allowed": true,
      "CountryCodes": "SE,MX,US"
    },
    "XactId": null,
    "NumberOfTracks": 0,
    "Status": "Validated",
    "CreatedDate": "0001-01-01T00:00:00",
    "LastUpdatedDate": "0001-01-01T00:00:00",
    "ValidationMessages": []
  },
  {
    "Artists": [
      {
        "id": "aefc2ebd-79ab-496b-85aa-69764...",
        "ArtistRelationTypeId": 1,
        "ArtistName": "Kalle Karlsson"
      },
      {
        "id": "4d002dc4-4914-43d7-a60d-4aa6...",
        "ArtistRelationTypeId": 1,
        "ArtistName": "Sven Svensson"
      }
    ],
    "id": "936da01f-9abd-4d9d-80c7-02af85c8...",
    "UserId": null,
    "StatusId": 20,
    "Version": 1,
    "CoverArtUrl": "http://cover...usic.com/?file=X517530.jpg",
    "Comment": "A simple comment",
    "OutletUris": [],
    "Tracks": [],
    "Title": "Memphis Blues",
    "GenreId": 26,
    "LanguageId": null,
    "ReleaseDate": "2009-09-17T00:00:00",
    "OriginalReleaseDate": null,
    "Upc": "7340050458923",
    "CatalogNumber": null,
    "TracksOrder": [],
    "Territory": {
      "Allowed": true,
      "CountryCodes": "SE,MX,US"
    },
    "XactId": null,
    "NumberOfTracks": 0,
    "Status": "Validated",
    "CreatedDate": "0001-01-01T00:00:00",
    "LastUpdatedDate": "0001-01-01T00:00:00",
    "ValidationMessages": []
  }
]

Response status

200 (OK)

/Users/{userId}/DistributorRoyaltyPercentageFee

Elevated access token required

description

Update a user's distributor royalty percentage fee.

url structure

http://localhost/Users/{userId}/DistributorRoyaltyPercentageFee

userId String The user identifier.

action

PostDistributorRoyaltyPercentageFee

method

POST

Request

Distributor royalty percentage fee request.

Request body

field	description
`DistributorRoyaltyPercentageFee`	Int32 A royalty percentage fee between 0 and 100 that the distributor keeps

Response

Distributor royalty percentage fee object.

Response body

field	description
`DistributorRoyaltyPercentageFee`	Int32 A royalty percentage fee between 0 and 100 that the distributor keeps

Response status

200 (OK)

/Users/{userId}/IsPublished

description

Has the user published a release?

url structure

http://localhost/Users/{userId}/IsPublished

userId String User identifier.

action

IsPublished

method

GET

Response

User object

Response body

field	description

Response status

200 (OK)

/Users/{userId}/Tracks/{trackId}

description

Get single track.

url structure

http://localhost/Users/{userId}/Tracks/{trackId}

userId String User identifier
trackId String Track identifier

action

Get

method

GET

Response

Track objects

Response body

field	description
`Artists`	IEnumerable`1 The Artists of the Track
`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

{
  "Artists": [
    {
      "id": "02af85c822a8fe333e3b-6b...",
      "TrackId": null,
      "ArtistRelationTypeId": 1,
      "ArtistName": "Adolf Eriksson"
    },
    {
      "id": "02af85c822a8fe333e3b-6b...",
      "TrackId": null,
      "ArtistRelationTypeId": 1,
      "ArtistName": "Adolf Eriksson"
    }
  ],
  "Index": 2,
  "id": "936da01f-9abd-4d9d-80c7-02af85c82...",
  "Title": "My first track",
  "GenreId": 26,
  "Isrc": null,
  "RecordingVersionId": 2430,
  "ExplicitLyrics": false,
  "IsCover": false,
  "FileName": null,
  "XactId": 0,
  "RecordingId": 0,
  "AlbumId": null,
  "Version": 123,
  "AudioUrl": "http://prelis...usic.com/?file=245945.mp3",
  "LanguageId": "en",
  "PreviewStart": "PT1M24S"
}

Response status

200 (OK)

/Users/{userId}/Tracks/{trackId}

description

Update a track.

url structure

http://localhost/Users/{userId}/Tracks/{trackId}

userId String User identifer
trackId String Identifier of the track to update

action

Put

method

PUT

Request

Parts of track object to update

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
`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

{
  "Title": "My best track",
  "GenreId": 26,
  "Isrc": null,
  "RecordingVersionId": 2430,
  "ExplicitLyrics": null,
  "IsCover": null,
  "LanguageId": null,
  "PreviewStart": null
}

Response

Updated track object

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

{
  "Index": 2,
  "id": "936da01f-9abd-4d9d-80c7-02af85c82...",
  "Title": "My first track",
  "GenreId": 26,
  "Isrc": null,
  "RecordingVersionId": 2430,
  "ExplicitLyrics": false,
  "IsCover": false,
  "FileName": null,
  "XactId": 0,
  "RecordingId": 0,
  "AlbumId": null,
  "Version": 123,
  "AudioUrl": "http://prelis...usic.com/?file=245945.mp3",
  "Artists": [],
  "LanguageId": "en",
  "PreviewStart": "PT1M24S"
}

Response status

200 (OK)

/Users/{userId}/Tracks/{trackId}

description

Delete a track.

url structure

http://localhost/Users/{userId}/Tracks/{trackId}

userId String User identifier
trackId String Identifier of the track to delete

action

Delete

method

DELETE

Response

Empty response

Response status

204 (NoContent)

/Users/{userId}/Tracks/{trackId}/Artists

description

Get artists for a specified track.

url structure

http://localhost/Users/{userId}/Tracks/{trackId}/Artists

userId String User identifier
trackId String Track identifier

action

Get

method

GET

Response

List of TrackArtist objects

Response body

field	description
`Item`	TrackArtistResponse

[
  {
    "id": "02af85c822a8fe333e3b-6b...",
    "TrackId": null,
    "ArtistRelationTypeId": 1,
    "ArtistName": "Adolf Eriksson"
  },
  {
    "id": "02af85c822a8fe333e3b-6b...",
    "TrackId": null,
    "ArtistRelationTypeId": 1,
    "ArtistName": "Adolf Eriksson"
  }
]

Response status

200 (OK)

/Users/{userId}/Tracks/{trackId}/Artists

description

Create an artist for a track.

url structure

http://localhost/Users/{userId}/Tracks/{trackId}/Artists

userId String User identifier
trackId String Track indentifier

action

PostCreate

method

POST

Request

Track artist object including album identifier

Request body

field	description
`ArtistRelationTypeId`	Nullable`1 Artist relation type identifier
`ArtistName`	String Artist name

{
  "ArtistRelationTypeId": 1,
  "ArtistName": "Olle Högberg"
}

Response

Created track artist object

Response body

field	description
`id`	String The id of the artist
`TrackId`	String Track identifier
`ArtistRelationTypeId`	Int32 Artist relation type identifier
`ArtistName`	String Artist name

{
  "id": "02af85c822a8fe333e3b-6b...",
  "TrackId": null,
  "ArtistRelationTypeId": 1,
  "ArtistName": "Adolf Eriksson"
}

Response status

201 (Created)

/Users/{userId}/Tracks/{trackId}/Artists/{artistId}

description

Update an artist for a track.

url structure

http://localhost/Users/{userId}/Tracks/{trackId}/Artists/{artistId}

userId String User indentifier
trackId String Track indentifier
artistId String Track level artist identifier

action

PutUpdate

method

PUT

Request

Album artist object

Request body

field	description
`ArtistRelationTypeId`	Nullable`1 Artist relation type identifier
`ArtistName`	String Artist name

{
  "ArtistRelationTypeId": 1,
  "ArtistName": "Olle Högberg"
}

Response

The updated track artist object

Response body

field	description
`id`	String The id of the artist
`TrackId`	String Track identifier
`ArtistRelationTypeId`	Int32 Artist relation type identifier
`ArtistName`	String Artist name

{
  "id": "02af85c822a8fe333e3b-6b...",
  "TrackId": null,
  "ArtistRelationTypeId": 1,
  "ArtistName": "Adolf Eriksson"
}

Response status

200 (OK)

/Users/{userId}/Tracks/{trackId}/Artists/{artistId}

description

Delete an artist from the track.

url structure

http://localhost/Users/{userId}/Tracks/{trackId}/Artists/{artistId}

userId String User identifier
trackId String Track indentifier
artistId String Track level artist identifier

action

Delete

method

DELETE

Response

Empty response

Response status

204 (NoContent)

/Users/{userId}/Tracks/{trackId}/AudioAsync

description

Upload an audio file and attaches it to a track (overwrites old audio file one already exists). The file is attached as file form-data in the body. Content-Type: multipart/form-data

url structure

http://localhost/Users/{userId}/Tracks/{trackId}/AudioAsync

userId String User identifier
trackId String Album identifier for album to upload cover art to

action

Post

method

POST

Response

File Uplopad Response

Response body

field	description
`ResourceId`	String
`id`	String
`ContentType`	String
`Uri`	Uri
`Status`	Int32 NotCompleted = 0Processing = 10Completed = 20Incomplete = 98Error = 99
`FileType`	Int32 Source = 0AudioLow = 1ImageExtraSmall = 2ImageSmall = 3ImageMedium = 4ImageLarge = 5ImageExtraLarge = 6
`Message`	String
`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.

{
  "ResourceId": null,
  "id": "12389128341928312",
  "ContentType": "audio/flac",
  "Uri": "covers:x5music:12389128341928312",
  "Status": 20,
  "FileType": 0,
  "Message": null
}

Response status

201 (Created)

/Users/{userId}/Tracks/{trackId}/FileStatus

description

Gets all file statuses for the resource (album)

url structure

http://localhost/Users/{userId}/Tracks/{trackId}/FileStatus

userId String The user Id
trackId String The Track id

action

GetFileStatuses

method

GET

Response

List of filestatuses

Response body

field	description
`Item`	FileUploadStatusResponse

[
  {
    "ResourceId": null,
    "id": "12389128341928312",
    "ContentType": "audio/flac",
    "Uri": "covers:x5music:12389128341928312",
    "Status": 20,
    "FileType": 0,
    "Message": null
  },
  {
    "ResourceId": null,
    "id": "12389128341928312",
    "ContentType": "audio/flac",
    "Uri": "covers:x5music:12389128341928312",
    "Status": 20,
    "FileType": 0,
    "Message": null
  }
]

Response status

200 (OK)

/Users/{userId}/Tracks/{trackId}/StoreTitle

description

Gets the store title for a track

url structure

http://localhost/Users/{userId}/Tracks/{trackId}/StoreTitle

userId String User identifier
trackId String Track identifier

action

GetStoreTitle

method

GET

Response

Track objects

Response body

field	description
`FullTitle`	String Complete title with version and artists
`VersionPart`	String Only version and artists
`TitlePart`	String Only title

{
  "FullTitle": "My Title (feat. Jazzy J) [Live]",
  "VersionPart": "(feat. Jazzy J) [Live]",
  "TitlePart": "My Title"
}

Response status

200 (OK)