Packages

The API response to the Packages query contains the API representation of the set of Packages accessible to your application.

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?format=json&access_token=TOKEN

Properties in the API Response

Name Type Description
none

Entities in the API Response

Name Class Description
Package package,collection API representation of a single package containing a collection of bundles.

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:packages"
  ],
  "class": [
    "collection",
    "packages"
  ],
  "properties": {
    "totalItems": 1,
    "currentCount": 1
  },
  "entities": [
    {
      "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"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/packages"
    }
  ]
}

Packages

The API response to the Packages query contains the API representation of the set of Packages accessible to your application.

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?format=json&access_token=TOKEN

Properties in the API Response

Name Type Description
none

Entities in the API Response

Name Class Description
Package package,collection API representation of a single package containing a collection of bundles.

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:packages"
  ],
  "class": [
    "collection",
    "packages"
  ],
  "properties": {
    "totalItems": 1,
    "currentCount": 1
  },
  "entities": [
    {
      "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"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/packages"
    }
  ]
}