Bundle

The API response to the Bundle query contains the API representation of a single Bundle accessible to your application.

Each Bundle contains a collection of Series or Movies that are assigned by Wurl.

For more information about how “Bundles” are used in the Wurl Index, visit the Wurl Index Hierarchy.

Request URL

https://api.wurl.com/api/bundles/BUNDLE_ID?format=json&access_token=TOKEN
  • BUNDLE_ID – a unique numeric identifier assigned to each Bundle
  • TOKEN - your Wurl API access token (Get more info at: Authentication Guide)

Properties in the API Response

Name Type Description
id number A number (assigned by Wurl) that uniquely identifies a Bundle.
title string The Bundle title (may include character sets from any of +50 languages).
slug string Unique descriptive identifier for the Bundle. Typically in English. (e.g. “Business_Korea”).
description string A description of the Bundle (may include character sets from any of +50 languages).
category string A Wurl-assigned category descriptor (e.g. 'News', 'Sports', 'Comedy'). Bundles may be browsed by category on our Programming Bundles page.
primaryLanguage string Two-letter identifier of the primary spoken language of the videos in this Bundle. See ISO 639-1 codes.
topSeries array Deprecated. Contains an array describing the five first Series in this Bundle. You should get this information from the series in the entities array with the 'top-series' rel instead.
totalItems number Total number of series in the bundle.

Entities in the API Response

Name Class Description
Bundle Items Link bundle_items,bundle-items,collection,link,wurl-bundle-items Sub-entity link to the API representation of the bundle items for this bundle.
Series series,wurl-series The response to the Series API request contains the representation of a video Series in the Wurl Index. In the Wurl Index, each Series contains a set of Episodes. The 'Series’ publisher determines the selection and order of the Episodes in a Series.

Links in the API Response

Name Description
self The canonical or preferred url to a resource.
schema The url to a resource's json-schema.
up The url to the parent of this resource.

Sample API Response

{
  "rel": [
    "urn:x-resource:name:bundle",
    "urn:x-resource:schema:https://api.wurl.com/schemas/bundle.json"
  ],
  "class": [
    "bundle",
    "wurl-bundle"
  ],
  "properties": {
    "id": 56,
    "title": "Featured Videos",
    "slug": "Featured_US",
    "description": "Featured series for US market",
    "primaryLanguage": "en",
    "category": "Mix",
    "totalItems": 15
  },
  "entities": [
    {
      "rel": [
        "top-series",
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series",
        "wurl-series"
      ],
      "properties": {
        "id": 393499,
        "description": "CelebTV is a top provider of award-winning online entertainment content, creating more than 50 videos each week about celebrity style & fashion, fitness, TV & movies, red carpet events, Hollywood families and more.   With several branded channels including CelebTV Studio, CelebTV Fit, CelebTV Style, CelebTV Teen and CelebTV Latino, we are the leader in short-form digital Entertainment programming. \n\nTo inquire about being a partner click here: http://bit.ly/YTeDrx\n• For more celebrity videos subscribe to CELEBTV at: http://bit.ly/CelebTV_YT\n• Visit CelebTV's website at: http://bit.ly/JSeJn \n• Subscribe to CELEBTV Latino at: http://bit.ly/YT3XZR",
        "channelsRank": 76.2753259955154,
        "pubDate": "2013-12-06T13:53:27Z",
        "title": "CelebTV",
        "thumbnails": {
          "default": {
            "url": "http://static0.channels.com/thumbnails/assets/youtube-com/feeds/192-2240/393499/Uploads-by-CelebTV--jpg"
          }
        },
        "totalEpisodes": 789,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCySVh8_pPCfBC1DTxm_7IYQ/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes",
            "episodes"
          ],
          "href": "https://api.wurl.com/api/series/393499/episodes",
          "class": [
            "link",
            "episodes",
            "wurl-episodes",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 393499
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 393499
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/393499"
        },
        {
          "rel": [
            "schema"
          ],
          "href": "https://api.wurl.com/schemas/series.json"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:items",
        "bundle-items"
      ],
      "href": "https://api.wurl.com/api/bundles/56/items",
      "class": [
        "link",
        "collection",
        "bundle-items",
        "wurl-bundle-items"
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/bundles/56"
    },
    {
      "rel": [
        "up"
      ],
      "href": "https://api.wurl.com/api/bundles"
    }
  ]
}

Bundle

The API response to the Bundle query contains the API representation of a single Bundle accessible to your application.

Each Bundle contains a collection of Series or Movies that are assigned by Wurl.

For more information about how “Bundles” are used in the Wurl Index, visit the Wurl Index Hierarchy.

Request URL

https://api.wurl.com/api/bundles/BUNDLE_ID?format=json&access_token=TOKEN

Properties in the API Response

Name Type Description
id number A number (assigned by Wurl) that uniquely identifies a Bundle.
title string The Bundle title (may include character sets from any of +50 languages).
slug string Unique descriptive identifier for the Bundle. Typically in English. (e.g. “Business_Korea”).
description string A description of the Bundle (may include character sets from any of +50 languages).
category string A Wurl-assigned category descriptor (e.g. 'News', 'Sports', 'Comedy'). Bundles may be browsed by category on our Programming Bundles page.
primaryLanguage string Two-letter identifier of the primary spoken language of the videos in this Bundle. See ISO 639-1 codes.
topSeries array Deprecated. Contains an array describing the five first Series in this Bundle. You should get this information from the series in the entities array with the 'top-series' rel instead.
totalItems number Total number of series in the bundle.

Entities in the API Response

Name Class Description
Bundle Items Link bundle_items,bundle-items,collection,link,wurl-bundle-items Sub-entity link to the API representation of the bundle items for this bundle.
Series series,wurl-series The response to the Series API request contains the representation of a video Series in the Wurl Index. In the Wurl Index, each Series contains a set of Episodes. The 'Series’ publisher determines the selection and order of the Episodes in a Series.

Links in the API Response

Name Description
self The canonical or preferred url to a resource.
schema The url to a resource's json-schema.
up The url to the parent of this resource.

Sample API Response

{
  "rel": [
    "urn:x-resource:name:bundle",
    "urn:x-resource:schema:https://api.wurl.com/schemas/bundle.json"
  ],
  "class": [
    "bundle",
    "wurl-bundle"
  ],
  "properties": {
    "id": 56,
    "title": "Featured Videos",
    "slug": "Featured_US",
    "description": "Featured series for US market",
    "primaryLanguage": "en",
    "category": "Mix",
    "totalItems": 15
  },
  "entities": [
    {
      "rel": [
        "top-series",
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series",
        "wurl-series"
      ],
      "properties": {
        "id": 393499,
        "description": "CelebTV is a top provider of award-winning online entertainment content, creating more than 50 videos each week about celebrity style & fashion, fitness, TV & movies, red carpet events, Hollywood families and more.   With several branded channels including CelebTV Studio, CelebTV Fit, CelebTV Style, CelebTV Teen and CelebTV Latino, we are the leader in short-form digital Entertainment programming. \n\nTo inquire about being a partner click here: http://bit.ly/YTeDrx\n• For more celebrity videos subscribe to CELEBTV at: http://bit.ly/CelebTV_YT\n• Visit CelebTV's website at: http://bit.ly/JSeJn \n• Subscribe to CELEBTV Latino at: http://bit.ly/YT3XZR",
        "channelsRank": 76.2753259955154,
        "pubDate": "2013-12-06T13:53:27Z",
        "title": "CelebTV",
        "thumbnails": {
          "default": {
            "url": "http://static0.channels.com/thumbnails/assets/youtube-com/feeds/192-2240/393499/Uploads-by-CelebTV--jpg"
          }
        },
        "totalEpisodes": 789,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCySVh8_pPCfBC1DTxm_7IYQ/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes",
            "episodes"
          ],
          "href": "https://api.wurl.com/api/series/393499/episodes",
          "class": [
            "link",
            "episodes",
            "wurl-episodes",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 393499
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 393499
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/393499"
        },
        {
          "rel": [
            "schema"
          ],
          "href": "https://api.wurl.com/schemas/series.json"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:items",
        "bundle-items"
      ],
      "href": "https://api.wurl.com/api/bundles/56/items",
      "class": [
        "link",
        "collection",
        "bundle-items",
        "wurl-bundle-items"
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/bundles/56"
    },
    {
      "rel": [
        "up"
      ],
      "href": "https://api.wurl.com/api/bundles"
    }
  ]
}