Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Playlist (JSON)

Playlist (JSON)

A list of tracks and their metadata.

Playlist

The Playlist object has the following specification.

MemberTypeDescription
IdstringIdentifier for this piece of content. All Ids are of the form {namespace}.{actual identifier} and may be used in any API accepting an ID as input.
NamestringThe name of this piece of content.
ImageUrlstringA direct link to the default image associated with this piece of content. See Image Service for details about how these links may be customized to produce different images.
LinkstringAn HTTP link that redirects to a contextual page for this piece of content on the relevant Groove client application, depending on the user's device or operating system. See DeepLink for details about how these links work and how they should be modified for revenue-sharing.
OtherIds Dictionary<string,string> An optional collection of IDs on top of the main ID, which identify this piece of content. Each key is the namespace or sub-namespace in which the ID belongs, and each value is a secondary ID for this piece of content
SourcestringAn indication of the data source for this piece of content. Possible values are Collection and Catalog.
CompatibleSourcesstringAn indication of the categories of APIs and actions that this piece of content can be used with. Comma-separated list of one or multiple values among "Catalog", "Collection". Most items are compatible with both Catalog and Collection actions, but playlists for example or some collection items are not valid in a Catalog context.
TrackCount32-bit signed integerNumber of tracks currently in the playlist.
DescriptionstringA short description of the playlist.
OwnerstringGamertag of the owner of the playlist.
IsReadOnlyBoolean valueWhether the playlist can be edited or not.
IsPublishedBoolean valueWhether the playlist is publicly visible or not.
UserIsOwnerBoolean valueWhether the current user is the actual owner of the playlist.
CollectionStateTokenstringToken indicating the current version of the collection.
TracksPaginated list of TrackA paginated list of the tracks in the playlist. In case of a browse, this list is null, and you'll need a lookup on that playlist to get its tracks.

Sample JSON syntax

{
  "TrackCount": 2,
  "UserIsOwner": true,
  "CollectionStateToken": "3.0.1.1.7.7.7",
  "Tracks": {
    "Items": [
      {
        "ReleaseDate": "2013-05-09T02:00:00+02:00",
        "Duration": "00:06:07",
        "TrackNumber": 8,
        "IsExplicit": false,
        "Genres": [
          "Pop"
        ],
        "Rights": [
          "Purchase",
          "FreeStream"
        ],
        "Album": {
          "ReleaseDate": "2013-05-09T02:00:00+02:00",
          "Genres": [
            "Pop"
          ],
          "Id": "music.AQEDB7k-sQABAA",
          "Name": "Random Access Memories",
          "ImageUrl": "http://musicimage.xboxlive.com/content/music.b13eb907-0100-11db-89ca-0019b92a3933/image?locale=en-US",
          "Link": "http://music.xbox.com/Album/b13eb907-0100-11db-89ca-0019b92a3933?partnerID=AwesomePartner",
          "Source": "Collection"
          "CompatibleSources": "Catalog, Collection"
        },
        "Artists": [
          {
            "Role": "Main",
            "Artist": {
              "Id": "music.AQIDAAAcxgACAA",
              "Name": "Daft Punk",
              "ImageUrl": "http://musicimage.xboxlive.com/content/music.c61c0000-0200-11db-89ca-0019b92a3933/image?locale=en-US",
              "Link": "http://music.xbox.com/Artist/c61c0000-0200-11db-89ca-0019b92a3933?partnerID=AwesomePartner",
              "Source": "Collection"
              "CompatibleSources": "Catalog, Collection"
            }
          },
          {
            "Role": "AlbumArtist",
            "Artist": {
              "Id": "music.AQIDAAAcxgACAA",
              "Name": "Daft Punk",
              "ImageUrl": "http://musicimage.xboxlive.com/content/music.c61c0000-0200-11db-89ca-0019b92a3933/image?locale=en-US",
              "Link": "http://music.xbox.com/Artist/c61c0000-0200-11db-89ca-0019b92a3933?partnerID=AwesomePartner",
              "Source": "Collection"
              "CompatibleSources": "Catalog, Collection"
            }
          }
        ],
        "Id": "music.AQQfN4uJ9UrnJkGWQ1G9KcPOkwe5PqgAAQ",
        "Name": "Get Lucky (feat. Pharrell Williams)",
        "ImageUrl": "http://musicimage.xboxlive.com/content/music.a83eb907-0100-11db-89ca-0019b92a3933/image?locale=en-US",
        "Link": "http://music.xbox.com/Track/a83eb907-0100-11db-89ca-0019b92a3933?partnerID=AwesomePartner",
        "Source": "Collection"
        "CompatibleSources": "Catalog, Collection"
      },
      {
        "ReleaseDate": "2013-09-27T02:00:00+02:00",
        "Duration": "00:04:46",
        "TrackNumber": 7,
        "IsExplicit": false,
        "Genres": [
          "Electronic / Dance"
        ],
        "Album": {
          "ReleaseDate": "2013-09-27T02:00:00+02:00",
          "Genres": [
            "Electronic / Dance"
          ],
          "Id": "music.AQEDB-rrJgABAA",
          "Name": "Aleph",
          "ImageUrl": "http://musicimage.xboxlive.com/content/music.26ebea07-0100-11db-89ca-0019b92a3933/image?locale=en-US",
          "Link": "http://music.xbox.com/Album/26ebea07-0100-11db-89ca-0019b92a3933?partnerID=AwesomePartner",
          "Source": "Collection"
          "CompatibleSources": "Catalog, Collection"
        },
        "Artists": [
          {
            "Role": "Main",
            "Artist": {
              "Id": "music.AQIDAAdbyQACAA",
              "Name": "Gesaffelstein",
              "ImageUrl": "http://musicimage.xboxlive.com/content/music.c95b0700-0200-11db-89ca-0019b92a3933/image?locale=en-US",
              "Link": "http://music.xbox.com/Artist/c95b0700-0200-11db-89ca-0019b92a3933?partnerID=AwesomePartner",
              "Source": "Collection"
              "CompatibleSources": "Catalog, Collection"
            }
          },
          {
            "Role": "AlbumArtist",
            "Artist": {
              "Id": "music.AQIDAAdbyQACAA",
              "Name": "Gesaffelstein",
              "ImageUrl": "http://musicimage.xboxlive.com/content/music.c95b0700-0200-11db-89ca-0019b92a3933/image?locale=en-US",
              "Link": "http://music.xbox.com/Artist/c95b0700-0200-11db-89ca-0019b92a3933?partnerID=AwesomePartner",
              "Source": "Collection"
              "CompatibleSources": "Catalog, Collection"
            }
          }
        ],
        "Id": "music.AQQfObc7JPSYfEi_EiGVYbdyHAfq6y0AAQ",
        "Name": "Aleph",
        "ImageUrl": "http://musicimage.xboxlive.com/content/music.2debea07-0100-11db-89ca-0019b92a3933/image?locale=en-US",
        "Link": "http://music.xbox.com/Track/2debea07-0100-11db-89ca-0019b92a3933?partnerID=AwesomePartner",
        "Source": "Collection"
        "CompatibleSources": "Catalog, Collection"
      }
    ],
    "TotalItemCount": 2
  },
  "Id": "music.playlist.56c99764-800a-00fe-552f-ee11db9370d1",
  "Name": "Playlist1",
  "ImageUrl": "http://musicimage.xboxlive.com/content/music.playlist.56c99764-800a-00fe-552f-ee11db9370d1/image?locale=en-US",
  "Link": "http://music.xbox.com/Playlist/56c99764-800a-00fe-552f-ee11db9370d1?partnerID=AwesomePartner",
  "Source": "Collection"
  "Compatible Sources": "Catalog, Collection"
}
      

Community Additions

ADD
Show:
© 2015 Microsoft