Episodes

This Wurl API request is used to return the API representation of the list of all of the video Episodes in a Series. Third-party publishers (video creators) determine the selection of Episodes in a Series and the order in which they appear.

Request URL

https://api.wurl.com/api/series/SERIES_ID/episodes?format=json&access_token=TOKEN
  • SERIES_ID – a unique identifier for a Series in the Wurl Index (e.g. 394565)
  • TOKEN - your Wurl API access token (Get more info at: Authentication Guide)

Properties in the API Response

Name Type Description
totalItems number The total number of episodes for the show.
currentCount number The number of episodes included in this response.
nextMaxId number The next max episode id to use when cursoring.

Entities in the API Response

The API response contains an array of Entities – one for each Episode in a Series plus an entity link to the parent series. For a description of the individual elements in the Episodes API response, see EPISODE Entity .

Name Class Description
Episode episode A single video that is published by a Series.
Series Link link,series,wurl-series Sub-entity link to the API representation of a Wurl 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.
next The url to the next set of items.
previous The url to the previous set of items.

Sample API Response

{
  "rel": [
    "urn:x-resource:schema:https://api.wurl.com/schemas/episodes.json"
  ],
  "class": [
    "collection",
    "episodes",
    "wurl-episodes"
  ],
  "properties": {
    "totalItems": 2,
    "currentCount": 2
  },
  "entities": [
    {
      "rel": [
        "series",
        "urn:x-resource:name:series"
      ],
      "href": "https://api.wurl.com/api/series/405266",
      "class": [
        "link",
        "series",
        "wurl-series"
      ]
    },
    {
      "rel": [
        "episode",
        "item",
        "urn:x-resource:name:episode",
        "urn:x-resource:schema:https://api.wurl.com/schemas/episode.json"
      ],
      "class": [
        "episode",
        "wurl-episode"
      ],
      "properties": {
        "id": 31334969,
        "studioName": "info@wurl.com",
        "description": "Lola Gold, a TV producer, entices The Awesomes to boost their profile.",
        "channelsRank": 59.660391342665,
        "height": 720,
        "pubDate": "2015-10-12T14:12:02.000Z",
        "title": "The Awesomes Season 2 Ep 5 - The Awesome's Awesome",
        "link": "http://wurl.com",
        "thumbnails": {
          "default": {
            "url": "http://static1.wurl.com/thumbs/2245/episodes/31334969-jpg"
          }
        },
        "showId": 405266,
        "width": 1280,
        "playback": [
          {
            "aspectRatio": "16:9",
            "definition": "hd",
            "duration": 318,
            "embed": "<video controls preload=\"auto\" height=\"448\" style=\"width: 100%; image-fit: fill; object-fit:fill;\" poster=\"http://static1.wurl.com/thumbs/2245/episodes/31334969-jpg\">\n    <source src=\"http://media.wurl.com/auto/7e6884ebe/item.wurl\" type=\"*/*\"/>\n</video>\n\n",
            "mediaUrl": "http://media.wurl.com/auto/7e6884ebe/item.wurl",
            "provider": "",
            "mediaType": "*/*",
            "type": "html5"
          },
          {
            "aspectRatio": "16:9",
            "definition": "hd",
            "duration": 318,
            "mediaUrl": "http://media.wurl.com/auto/7e6884ebe/item.wurl",
            "provider": "",
            "mediaType": "*/*",
            "type": "direct"
          }
        ]
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:series",
            "series"
          ],
          "href": "https://api.wurl.com/api/series/405266",
          "class": [
            "link",
            "series",
            "wurl-series"
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/405266/episodes/31334969"
        },
        {
          "rel": [
            "schema"
          ],
          "href": "https://api.wurl.com/schemas/episode.json"
        }
      ]
    },
    {
      "rel": [
        "episode",
        "item",
        "urn:x-resource:name:episode",
        "urn:x-resource:schema:https://api.wurl.com/schemas/episode.json"
      ],
      "class": [
        "episode",
        "wurl-episode"
      ],
      "properties": {
        "id": 31334970,
        "studioName": "info@wurl.com",
        "description": "The Awesomes follow Tim back to school.",
        "channelsRank": 59.660391342665,
        "height": 720,
        "pubDate": "2015-10-12T13:12:02.000Z",
        "title": "The Awesomes Season 2 Ep 4 - Tim Goes to School",
        "link": "http://wurl.com",
        "thumbnails": {
          "default": {
            "url": "http://static1.wurl.com/thumbs/2245/episodes/31334970-jpg"
          }
        },
        "showId": 405266,
        "width": 1280,
        "playback": [
          {
            "aspectRatio": "16:9",
            "definition": "hd",
            "duration": 62,
            "embed": "<video controls preload=\"auto\" height=\"448\" style=\"width: 100%; image-fit: fill; object-fit:fill;\" poster=\"http://static1.wurl.com/thumbs/2245/episodes/31334970-jpg\">\n    <source src=\"http://media.wurl.com/auto/y79084ebe/item.wurl\" type=\"*/*\"/>\n</video>\n\n",
            "mediaUrl": "http://media.wurl.com/auto/y79084ebe/item.wurl",
            "provider": "",
            "mediaType": "*/*",
            "type": "html5"
          },
          {
            "aspectRatio": "16:9",
            "definition": "hd",
            "duration": 62,
            "mediaUrl": "http://media.wurl.com/auto/y79084ebe/item.wurl",
            "provider": "",
            "mediaType": "*/*",
            "type": "direct"
          }
        ]
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:series",
            "series"
          ],
          "href": "https://api.wurl.com/api/series/405266",
          "class": [
            "link",
            "series",
            "wurl-series"
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/405266/episodes/31334970"
        },
        {
          "rel": [
            "schema"
          ],
          "href": "https://api.wurl.com/schemas/episode.json"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/series/405266/episodes"
    },
    {
      "rel": [
        "schema"
      ],
      "href": "https://api.wurl.com/schemas/episodes.json"
    }
  ]
}

Episodes

This Wurl API request is used to return the API representation of the list of all of the video Episodes in a Series. Third-party publishers (video creators) determine the selection of Episodes in a Series and the order in which they appear.

Request URL

https://api.wurl.com/api/series/SERIES_ID/episodes?format=json&access_token=TOKEN

Properties in the API Response

Name Type Description
totalItems number The total number of episodes for the show.
currentCount number The number of episodes included in this response.
nextMaxId number The next max episode id to use when cursoring.

Entities in the API Response

The API response contains an array of Entities – one for each Episode in a Series plus an entity link to the parent series. For a description of the individual elements in the Episodes API response, see EPISODE Entity .

Name Class Description
Episode episode A single video that is published by a Series.
Series Link link,series,wurl-series Sub-entity link to the API representation of a Wurl 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.
next The url to the next set of items.
previous The url to the previous set of items.

Sample API Response

{
  "rel": [
    "urn:x-resource:schema:https://api.wurl.com/schemas/episodes.json"
  ],
  "class": [
    "collection",
    "episodes",
    "wurl-episodes"
  ],
  "properties": {
    "totalItems": 2,
    "currentCount": 2
  },
  "entities": [
    {
      "rel": [
        "series",
        "urn:x-resource:name:series"
      ],
      "href": "https://api.wurl.com/api/series/405266",
      "class": [
        "link",
        "series",
        "wurl-series"
      ]
    },
    {
      "rel": [
        "episode",
        "item",
        "urn:x-resource:name:episode",
        "urn:x-resource:schema:https://api.wurl.com/schemas/episode.json"
      ],
      "class": [
        "episode",
        "wurl-episode"
      ],
      "properties": {
        "id": 31334969,
        "studioName": "info@wurl.com",
        "description": "Lola Gold, a TV producer, entices The Awesomes to boost their profile.",
        "channelsRank": 59.660391342665,
        "height": 720,
        "pubDate": "2015-10-12T14:12:02.000Z",
        "title": "The Awesomes Season 2 Ep 5 - The Awesome's Awesome",
        "link": "http://wurl.com",
        "thumbnails": {
          "default": {
            "url": "http://static1.wurl.com/thumbs/2245/episodes/31334969-jpg"
          }
        },
        "showId": 405266,
        "width": 1280,
        "playback": [
          {
            "aspectRatio": "16:9",
            "definition": "hd",
            "duration": 318,
            "embed": "<video controls preload=\"auto\" height=\"448\" style=\"width: 100%; image-fit: fill; object-fit:fill;\" poster=\"http://static1.wurl.com/thumbs/2245/episodes/31334969-jpg\">\n    <source src=\"http://media.wurl.com/auto/7e6884ebe/item.wurl\" type=\"*/*\"/>\n</video>\n\n",
            "mediaUrl": "http://media.wurl.com/auto/7e6884ebe/item.wurl",
            "provider": "",
            "mediaType": "*/*",
            "type": "html5"
          },
          {
            "aspectRatio": "16:9",
            "definition": "hd",
            "duration": 318,
            "mediaUrl": "http://media.wurl.com/auto/7e6884ebe/item.wurl",
            "provider": "",
            "mediaType": "*/*",
            "type": "direct"
          }
        ]
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:series",
            "series"
          ],
          "href": "https://api.wurl.com/api/series/405266",
          "class": [
            "link",
            "series",
            "wurl-series"
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/405266/episodes/31334969"
        },
        {
          "rel": [
            "schema"
          ],
          "href": "https://api.wurl.com/schemas/episode.json"
        }
      ]
    },
    {
      "rel": [
        "episode",
        "item",
        "urn:x-resource:name:episode",
        "urn:x-resource:schema:https://api.wurl.com/schemas/episode.json"
      ],
      "class": [
        "episode",
        "wurl-episode"
      ],
      "properties": {
        "id": 31334970,
        "studioName": "info@wurl.com",
        "description": "The Awesomes follow Tim back to school.",
        "channelsRank": 59.660391342665,
        "height": 720,
        "pubDate": "2015-10-12T13:12:02.000Z",
        "title": "The Awesomes Season 2 Ep 4 - Tim Goes to School",
        "link": "http://wurl.com",
        "thumbnails": {
          "default": {
            "url": "http://static1.wurl.com/thumbs/2245/episodes/31334970-jpg"
          }
        },
        "showId": 405266,
        "width": 1280,
        "playback": [
          {
            "aspectRatio": "16:9",
            "definition": "hd",
            "duration": 62,
            "embed": "<video controls preload=\"auto\" height=\"448\" style=\"width: 100%; image-fit: fill; object-fit:fill;\" poster=\"http://static1.wurl.com/thumbs/2245/episodes/31334970-jpg\">\n    <source src=\"http://media.wurl.com/auto/y79084ebe/item.wurl\" type=\"*/*\"/>\n</video>\n\n",
            "mediaUrl": "http://media.wurl.com/auto/y79084ebe/item.wurl",
            "provider": "",
            "mediaType": "*/*",
            "type": "html5"
          },
          {
            "aspectRatio": "16:9",
            "definition": "hd",
            "duration": 62,
            "mediaUrl": "http://media.wurl.com/auto/y79084ebe/item.wurl",
            "provider": "",
            "mediaType": "*/*",
            "type": "direct"
          }
        ]
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:series",
            "series"
          ],
          "href": "https://api.wurl.com/api/series/405266",
          "class": [
            "link",
            "series",
            "wurl-series"
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/405266/episodes/31334970"
        },
        {
          "rel": [
            "schema"
          ],
          "href": "https://api.wurl.com/schemas/episode.json"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/series/405266/episodes"
    },
    {
      "rel": [
        "schema"
      ],
      "href": "https://api.wurl.com/schemas/episodes.json"
    }
  ]
}