Package

API representation of a single package containing a collection of bundles.

A Wurl Package is a collection of Bundles (which are collections of Series). Developers use Packages to build “guides” that assist viewer discovery. The Bundles in each Wurl Package share a common region & spoken-language (e.g. “German Guide”) or a common genre (e.g. “Worldwide Sports”).

Wurl will create and manage new Packages and Bundles on request.

For more information about how 'Packages' are used in the Wurl Index, visit the Wurl Index Hierarchy.

Request URL

https://api.wurl.com/api/packages/PACKAGE_ID?format=json&access_token=TOKEN
  • PACKAGE_ID – a unique numeric identifier assigned to each Package
  • 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 Package.
title string The Package title (may include character sets from any of +50 languages).
slug string Unique descriptive identifier for the Package. Typically in English. (e.g. “Mix”).
price number The price of the package.
totalItems number The total number of bundles included in the package.

Entities in the API Response

The API response for 'Package' contains an array of Entities describing the set of Bundles available to your application and the Series within each of those Bundles.

To review the API response elements related to Bundles, visit BUNDLE Entity. To review the API response elements related to Bundles, visit BUNDLE Entity To review the API response elements related to Series, visit SERIES Entity.

Name Class Description
Bundle .*bundle The API response to the Bundle query contains the API representation of a single Bundle accessible to your application.

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": [
    "properties:http://api.wurl.com/schemas/package.json",
    "urn:x-resource:name:package"
  ],
  "class": [
    "package"
  ],
  "properties": {
    "id": 1,
    "price": "0.1",
    "title": "US Mix",
    "totalItems": 1
  },
  "entities": [
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/bundle.json",
        "urn:x-resource:name:bundle"
      ],
      "class": [
        "bundle"
      ],
      "properties": {
        "id": 12,
        "title": "U.S. Political News",
        "slug": "USPoliticsNews",
        "description": "Political shows from the United States",
        "primaryLanguage": null,
        "category": null,
        "topSeries": [

        ],
        "totalItems": 0
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:items"
          ],
          "href": "https://api.wurl.com/api/bundles/12/items",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/bundles/12"
        },
        {
          "rel": [
            "up"
          ],
          "href": "https://api.wurl.com/api/bundles"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/packages/1"
    }
  ]
}

Package

API representation of a single package containing a collection of bundles.

A Wurl Package is a collection of Bundles (which are collections of Series). Developers use Packages to build “guides” that assist viewer discovery. The Bundles in each Wurl Package share a common region & spoken-language (e.g. “German Guide”) or a common genre (e.g. “Worldwide Sports”).

Wurl will create and manage new Packages and Bundles on request.

For more information about how 'Packages' are used in the Wurl Index, visit the Wurl Index Hierarchy.

Request URL

https://api.wurl.com/api/packages/PACKAGE_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 Package.
title string The Package title (may include character sets from any of +50 languages).
slug string Unique descriptive identifier for the Package. Typically in English. (e.g. “Mix”).
price number The price of the package.
totalItems number The total number of bundles included in the package.

Entities in the API Response

The API response for 'Package' contains an array of Entities describing the set of Bundles available to your application and the Series within each of those Bundles.

To review the API response elements related to Bundles, visit BUNDLE Entity. To review the API response elements related to Bundles, visit BUNDLE Entity To review the API response elements related to Series, visit SERIES Entity.

Name Class Description
Bundle .*bundle The API response to the Bundle query contains the API representation of a single Bundle accessible to your application.

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": [
    "properties:http://api.wurl.com/schemas/package.json",
    "urn:x-resource:name:package"
  ],
  "class": [
    "package"
  ],
  "properties": {
    "id": 1,
    "price": "0.1",
    "title": "US Mix",
    "totalItems": 1
  },
  "entities": [
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/bundle.json",
        "urn:x-resource:name:bundle"
      ],
      "class": [
        "bundle"
      ],
      "properties": {
        "id": 12,
        "title": "U.S. Political News",
        "slug": "USPoliticsNews",
        "description": "Political shows from the United States",
        "primaryLanguage": null,
        "category": null,
        "topSeries": [

        ],
        "totalItems": 0
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:items"
          ],
          "href": "https://api.wurl.com/api/bundles/12/items",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/bundles/12"
        },
        {
          "rel": [
            "up"
          ],
          "href": "https://api.wurl.com/api/bundles"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/packages/1"
    }
  ]
}