Interface: Podcasts

Podcasts

Provides data on podcasts delivered from the TwentyThree platform.

Methods

<static> getAudio(id) → {Podcast}

/v2/podcasts/audio/:id

Fetches podcast with given id (daletBroadcastId).
Note, that the id is from dalet (not Twenty Three)

Parameters:
Name Type Description
id int

Broadcast id from Dalet

See:
  • /v2/podcasts/audio/90979
Returns:
Type
Podcast

<static> getAudio(id) → {Podcast}

/podcasts/audio/:id

Fetches podcast with given id (daletBroadcastId).
Note, that the id is from dalet (not Twenty Three)

Parameters:
Name Type Description
id int

Broadcast id from Dalet

See:
  • /podcasts/audio/90979
Returns:
Type
Podcast

<static> getMetadata(start) → {Object}

/podcasts/metadata/:start

Fetches metadata for given timestamp.
Note, this endpoint calls the Umbraco CMS for data.
The returned data is formatted differently from usual podcasts.

Parameters:
Name Type Description
start datetime

Timestamp for broadcast start in ISO-format

See:
  • /podcasts/metadata/2015-09-03T14:05:00Z
Returns:

Unformatted object from CMS.

Type
Object

<static> getNews() → {Array.<Podcast>}

/podcasts/news

Fetches the latest news

See:
  • /podcasts/news
Returns:

Array of a single podcast object for relevant news broadcast.

Type
Array.<Podcast>

<static> getNews() → {Array.<Podcast>}

/v2/podcasts/news

Fetches the latest news

See:
  • /v2/podcasts/news
Returns:

Array of a single podcast object for relevant news broadcast.

Type
Array.<Podcast>

/v2/podcasts/permalink/:id

Fetches permalink for given podcast id. Returns url.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /v2/podcasts/permalink/11800016
Returns:

Object containing direct link to website with audio
player loaded with relevant podcast.

Type
Object

/podcasts/permalink/:id

Fetches permalink for given podcast id. Returns url.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /podcasts/permalink/11800016
Returns:

Object containing direct link to website with audio
player loaded with relevant podcast.

Type
Object

<static> getPodcasts(videoProgramId, size, p, year, month) → {Array.<Podcast>}

/podcasts/program/:videoProgramId?size=:size&p=:p&year=:year&month=:month

Fetches podcasts for given program id

Parameters:
Name Type Argument Default Description
videoProgramId string

Program id or tag from Twenty Three.

size int <optional>
100

Number of podcasts to return

p int <optional>
0

Offset in pages

year int <optional>

Podcasts published in year

month int <optional>

Podcasts published in month

See:
  • /podcasts/program/3843763
Returns:

Array of podcasts for given program.

Type
Array.<Podcast>

<static> getPodcasts(videoProgramId, size, p, year, month) → {Array.<Podcast>}

/v2/podcasts/program/:videoProgramId?size=:size&p=:p&year=:year&month=:month

Fetches podcasts for given program id

Parameters:
Name Type Argument Default Description
videoProgramId string

Program id or tag from Twenty Three.

size int <optional>
100

Number of podcasts to return

p int <optional>
0

Offset in pages

year int <optional>

Podcasts published in year

month int <optional>

Podcasts published in month

See:
  • /v2/podcasts/program/3843763
Returns:

Array of podcasts for given program.

Type
Array.<Podcast>

<static> getPromos(videoProgramId) → {Array.<Podcast>}

/v2/podcasts/promos/10839671

Fetches the latest promo for given program id

Parameters:
Name Type Description
videoProgramId string

Program id or tag from Twenty Three.

See:
  • /v2/podcasts/promos/:videoProgramId
Returns:

Array of a podcast objects

Type
Array.<Podcast>

<static> getRelated(videoPodcastId) → {Array.<Podcast>}

/v2/podcasts/related/10839671

Fetches the related podcasts for given videoPodcastId

Parameters:
Name Type Description
videoPodcastId string

Podcast id from Twenty Three.

See:
  • /v2/podcasts/related/:videoPodcastId
Returns:

Array of a podcast objects

Type
Array.<Podcast>

<static> getSections(id, token) → {Array.<Object>}

/podcasts/sections/:id/:token

Fetches podcast's sections

Parameters:
Name Type Description
id int

Podcast id from 23video

token string

Podcast token from 23video

See:
  • /podcasts/sections/11800016/967f2d4497796da05085741607e9e0c5
Returns:

Array of objects with section data.

Type
Array.<Object>

<static> getSections(id, token) → {Array.<Object>}

/v2/podcasts/sections/:id/:token

Fetches podcast's sections

Parameters:
Name Type Description
id int

Podcast id from 23video

token string

Podcast token from 23video

See:
  • /v2/podcasts/sections/11800016/967f2d4497796da05085741607e9e0c5
Returns:

Array of objects with section data.

Type
Array.<Object>

<static> list(videoProgramId, size, p, search, tags, year, month)

/podcasts

Fetches latest podcasts.

Parameters:
Name Type Argument Default Description
videoProgramId string

Program id or tag from Twenty Three.

size int <optional>
100

Number of podcasts to return

p int <optional>
0

Offset in pages

search string

Keyword search across all params

tags string

Keyword search in tags

year int <optional>

Podcasts published in year

month int <optional>

Podcasts published in month

See:
  • /podcasts
Returns:

[Podcast]

<static> ratePodcast() → {Object}

/podcasts/rate/:videoPodcastId/:rating

Submits a rating of specific podcast to TwentyThree

Returns:

Object with videoPodcastId and rating

Type
Object

<static> ratePodcast() → {Object}

/v2/podcasts/rate/:videoPodcastId/:rating

Submits a rating of specific podcast to TwentyThree

Returns:

Object with videoPodcastId and rating

Type
Object

<static> show(id) → {Podcast}

/v2/podcasts/:id

Fetches podcast with given id.
Note, id is from Twenty Three.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /v2/podcasts/11800217
Returns:
Type
Podcast

<static> show(id) → {Podcast}

/podcasts/:id

Fetches podcast with given id.
Note, id is from Twenty Three.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /podcasts/11800217
Returns:
Type
Podcast

Interface: Podcasts

Podcasts

Provides data on podcasts delivered from the TwentyThree platform.

Methods

<static> getAudio(id) → {Podcast}

/v2/podcasts/audio/:id

Fetches podcast with given id (daletBroadcastId).
Note, that the id is from dalet (not Twenty Three)

Parameters:
Name Type Description
id int

Broadcast id from Dalet

See:
  • /v2/podcasts/audio/90979
Returns:
Type
Podcast

<static> getAudio(id) → {Podcast}

/podcasts/audio/:id

Fetches podcast with given id (daletBroadcastId).
Note, that the id is from dalet (not Twenty Three)

Parameters:
Name Type Description
id int

Broadcast id from Dalet

See:
  • /podcasts/audio/90979
Returns:
Type
Podcast

<static> getMetadata(start) → {Object}

/podcasts/metadata/:start

Fetches metadata for given timestamp.
Note, this endpoint calls the Umbraco CMS for data.
The returned data is formatted differently from usual podcasts.

Parameters:
Name Type Description
start datetime

Timestamp for broadcast start in ISO-format

See:
  • /podcasts/metadata/2015-09-03T14:05:00Z
Returns:

Unformatted object from CMS.

Type
Object

<static> getNews() → {Array.<Podcast>}

/podcasts/news

Fetches the latest news

See:
  • /podcasts/news
Returns:

Array of a single podcast object for relevant news broadcast.

Type
Array.<Podcast>

<static> getNews() → {Array.<Podcast>}

/v2/podcasts/news

Fetches the latest news

See:
  • /v2/podcasts/news
Returns:

Array of a single podcast object for relevant news broadcast.

Type
Array.<Podcast>

/v2/podcasts/permalink/:id

Fetches permalink for given podcast id. Returns url.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /v2/podcasts/permalink/11800016
Returns:

Object containing direct link to website with audio
player loaded with relevant podcast.

Type
Object

/podcasts/permalink/:id

Fetches permalink for given podcast id. Returns url.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /podcasts/permalink/11800016
Returns:

Object containing direct link to website with audio
player loaded with relevant podcast.

Type
Object

<static> getPodcasts(videoProgramId, size, p, year, month) → {Array.<Podcast>}

/podcasts/program/:videoProgramId?size=:size&p=:p&year=:year&month=:month

Fetches podcasts for given program id

Parameters:
Name Type Argument Default Description
videoProgramId string

Program id or tag from Twenty Three.

size int <optional>
100

Number of podcasts to return

p int <optional>
0

Offset in pages

year int <optional>

Podcasts published in year

month int <optional>

Podcasts published in month

See:
  • /podcasts/program/3843763
Returns:

Array of podcasts for given program.

Type
Array.<Podcast>

<static> getPodcasts(videoProgramId, size, p, year, month) → {Array.<Podcast>}

/v2/podcasts/program/:videoProgramId?size=:size&p=:p&year=:year&month=:month

Fetches podcasts for given program id

Parameters:
Name Type Argument Default Description
videoProgramId string

Program id or tag from Twenty Three.

size int <optional>
100

Number of podcasts to return

p int <optional>
0

Offset in pages

year int <optional>

Podcasts published in year

month int <optional>

Podcasts published in month

See:
  • /v2/podcasts/program/3843763
Returns:

Array of podcasts for given program.

Type
Array.<Podcast>

<static> getPromos(videoProgramId) → {Array.<Podcast>}

/v2/podcasts/promos/10839671

Fetches the latest promo for given program id

Parameters:
Name Type Description
videoProgramId string

Program id or tag from Twenty Three.

See:
  • /v2/podcasts/promos/:videoProgramId
Returns:

Array of a podcast objects

Type
Array.<Podcast>

<static> getRelated(videoPodcastId) → {Array.<Podcast>}

/v2/podcasts/related/10839671

Fetches the related podcasts for given videoPodcastId

Parameters:
Name Type Description
videoPodcastId string

Podcast id from Twenty Three.

See:
  • /v2/podcasts/related/:videoPodcastId
Returns:

Array of a podcast objects

Type
Array.<Podcast>

<static> getSections(id, token) → {Array.<Object>}

/podcasts/sections/:id/:token

Fetches podcast's sections

Parameters:
Name Type Description
id int

Podcast id from 23video

token string

Podcast token from 23video

See:
  • /podcasts/sections/11800016/967f2d4497796da05085741607e9e0c5
Returns:

Array of objects with section data.

Type
Array.<Object>

<static> getSections(id, token) → {Array.<Object>}

/v2/podcasts/sections/:id/:token

Fetches podcast's sections

Parameters:
Name Type Description
id int

Podcast id from 23video

token string

Podcast token from 23video

See:
  • /v2/podcasts/sections/11800016/967f2d4497796da05085741607e9e0c5
Returns:

Array of objects with section data.

Type
Array.<Object>

<static> list(videoProgramId, size, p, search, tags, year, month)

/podcasts

Fetches latest podcasts.

Parameters:
Name Type Argument Default Description
videoProgramId string

Program id or tag from Twenty Three.

size int <optional>
100

Number of podcasts to return

p int <optional>
0

Offset in pages

search string

Keyword search across all params

tags string

Keyword search in tags

year int <optional>

Podcasts published in year

month int <optional>

Podcasts published in month

See:
  • /podcasts
Returns:

[Podcast]

<static> ratePodcast() → {Object}

/podcasts/rate/:videoPodcastId/:rating

Submits a rating of specific podcast to TwentyThree

Returns:

Object with videoPodcastId and rating

Type
Object

<static> ratePodcast() → {Object}

/v2/podcasts/rate/:videoPodcastId/:rating

Submits a rating of specific podcast to TwentyThree

Returns:

Object with videoPodcastId and rating

Type
Object

<static> show(id) → {Podcast}

/v2/podcasts/:id

Fetches podcast with given id.
Note, id is from Twenty Three.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /v2/podcasts/11800217
Returns:
Type
Podcast

<static> show(id) → {Podcast}

/podcasts/:id

Fetches podcast with given id.
Note, id is from Twenty Three.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /podcasts/11800217
Returns:
Type
Podcast

Interface: Podcasts

Podcasts

Provides data on podcasts delivered from the TwentyThree platform.

Methods

<static> getAudio(id) → {Podcast}

/v2/podcasts/audio/:id

Fetches podcast with given id (daletBroadcastId).
Note, that the id is from dalet (not Twenty Three)

Parameters:
Name Type Description
id int

Broadcast id from Dalet

See:
  • /v2/podcasts/audio/90979
Returns:
Type
Podcast

<static> getAudio(id) → {Podcast}

/podcasts/audio/:id

Fetches podcast with given id (daletBroadcastId).
Note, that the id is from dalet (not Twenty Three)

Parameters:
Name Type Description
id int

Broadcast id from Dalet

See:
  • /podcasts/audio/90979
Returns:
Type
Podcast

<static> getMetadata(start) → {Object}

/podcasts/metadata/:start

Fetches metadata for given timestamp.
Note, this endpoint calls the Umbraco CMS for data.
The returned data is formatted differently from usual podcasts.

Parameters:
Name Type Description
start datetime

Timestamp for broadcast start in ISO-format

See:
  • /podcasts/metadata/2015-09-03T14:05:00Z
Returns:

Unformatted object from CMS.

Type
Object

<static> getNews() → {Array.<Podcast>}

/podcasts/news

Fetches the latest news

See:
  • /podcasts/news
Returns:

Array of a single podcast object for relevant news broadcast.

Type
Array.<Podcast>

<static> getNews() → {Array.<Podcast>}

/v2/podcasts/news

Fetches the latest news

See:
  • /v2/podcasts/news
Returns:

Array of a single podcast object for relevant news broadcast.

Type
Array.<Podcast>

/v2/podcasts/permalink/:id

Fetches permalink for given podcast id. Returns url.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /v2/podcasts/permalink/11800016
Returns:

Object containing direct link to website with audio
player loaded with relevant podcast.

Type
Object

/podcasts/permalink/:id

Fetches permalink for given podcast id. Returns url.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /podcasts/permalink/11800016
Returns:

Object containing direct link to website with audio
player loaded with relevant podcast.

Type
Object

<static> getPodcasts(videoProgramId, size, p, year, month) → {Array.<Podcast>}

/podcasts/program/:videoProgramId?size=:size&p=:p&year=:year&month=:month

Fetches podcasts for given program id

Parameters:
Name Type Argument Default Description
videoProgramId string

Program id or tag from Twenty Three.

size int <optional>
100

Number of podcasts to return

p int <optional>
0

Offset in pages

year int <optional>

Podcasts published in year

month int <optional>

Podcasts published in month

See:
  • /podcasts/program/3843763
Returns:

Array of podcasts for given program.

Type
Array.<Podcast>

<static> getPodcasts(videoProgramId, size, p, year, month) → {Array.<Podcast>}

/v2/podcasts/program/:videoProgramId?size=:size&p=:p&year=:year&month=:month

Fetches podcasts for given program id

Parameters:
Name Type Argument Default Description
videoProgramId string

Program id or tag from Twenty Three.

size int <optional>
100

Number of podcasts to return

p int <optional>
0

Offset in pages

year int <optional>

Podcasts published in year

month int <optional>

Podcasts published in month

See:
  • /v2/podcasts/program/3843763
Returns:

Array of podcasts for given program.

Type
Array.<Podcast>

<static> getPromos(videoProgramId) → {Array.<Podcast>}

/v2/podcasts/promos/10839671

Fetches the latest promo for given program id

Parameters:
Name Type Description
videoProgramId string

Program id or tag from Twenty Three.

See:
  • /v2/podcasts/promos/:videoProgramId
Returns:

Array of a podcast objects

Type
Array.<Podcast>

<static> getRelated(videoPodcastId) → {Array.<Podcast>}

/v2/podcasts/related/10839671

Fetches the related podcasts for given videoPodcastId

Parameters:
Name Type Description
videoPodcastId string

Podcast id from Twenty Three.

See:
  • /v2/podcasts/related/:videoPodcastId
Returns:

Array of a podcast objects

Type
Array.<Podcast>

<static> getSections(id, token) → {Array.<Object>}

/podcasts/sections/:id/:token

Fetches podcast's sections

Parameters:
Name Type Description
id int

Podcast id from 23video

token string

Podcast token from 23video

See:
  • /podcasts/sections/11800016/967f2d4497796da05085741607e9e0c5
Returns:

Array of objects with section data.

Type
Array.<Object>

<static> getSections(id, token) → {Array.<Object>}

/v2/podcasts/sections/:id/:token

Fetches podcast's sections

Parameters:
Name Type Description
id int

Podcast id from 23video

token string

Podcast token from 23video

See:
  • /v2/podcasts/sections/11800016/967f2d4497796da05085741607e9e0c5
Returns:

Array of objects with section data.

Type
Array.<Object>

<static> list(videoProgramId, size, p, search, tags, year, month)

/podcasts

Fetches latest podcasts.

Parameters:
Name Type Argument Default Description
videoProgramId string

Program id or tag from Twenty Three.

size int <optional>
100

Number of podcasts to return

p int <optional>
0

Offset in pages

search string

Keyword search across all params

tags string

Keyword search in tags

year int <optional>

Podcasts published in year

month int <optional>

Podcasts published in month

See:
  • /podcasts
Returns:

[Podcast]

<static> ratePodcast() → {Object}

/podcasts/rate/:videoPodcastId/:rating

Submits a rating of specific podcast to TwentyThree

Returns:

Object with videoPodcastId and rating

Type
Object

<static> ratePodcast() → {Object}

/v2/podcasts/rate/:videoPodcastId/:rating

Submits a rating of specific podcast to TwentyThree

Returns:

Object with videoPodcastId and rating

Type
Object

<static> show(id) → {Podcast}

/v2/podcasts/:id

Fetches podcast with given id.
Note, id is from Twenty Three.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /v2/podcasts/11800217
Returns:
Type
Podcast

<static> show(id) → {Podcast}

/podcasts/:id

Fetches podcast with given id.
Note, id is from Twenty Three.

Parameters:
Name Type Description
id int

Podcast id from 23video

See:
  • /podcasts/11800217
Returns:
Type
Podcast