flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

get_broadcasts

All broadcasts

OnInit
./lib/actions/get_broadcasts.js
OnStartup
-
OnClose
-

Attributes

-

get_broadcasts_latest

Broadcasts for the current day

OnInit
./lib/actions/get_broadcasts_latest.js
OnStartup
-
OnClose
-

Attributes

-

getBroadcastByPid

Find broadcast by PID

OnInit
./lib/actions/getBroadcastByPid.js
OnStartup
-
OnClose
-

Attributes

-

get_categories

Retrieve Categories

OnInit
./lib/actions/get_categories.js
OnStartup
-
OnClose
-

Attributes

-

get_categories__id_

Retrieve Categories by ID

OnInit
./lib/actions/get_categories__id_.js
OnStartup
-
OnClose
-

Attributes

-

getCollectionMembers

Episodes and Clips from Collection

OnInit
./lib/actions/getCollectionMembers.js
OnStartup
-
OnClose
-

Attributes

-

getExperienceHomepage

Homepage Experience

OnInit
./lib/actions/getExperienceHomepage.js
OnStartup
-
OnClose
-

Attributes

-

getMusicPopularArtists

List of Most Popular artists from BBC Music.

OnInit
./lib/actions/getMusicPopularArtists.js
OnStartup
-
OnClose
-

Attributes

-

getMusicPopularArtistById

Popularity Artist By Id

OnInit
./lib/actions/getMusicPopularArtistById.js
OnStartup
-
OnClose
-

Attributes

-

getMusicPopularPlaylists

List of Most Popular playlists from BBC Music.

OnInit
./lib/actions/getMusicPopularPlaylists.js
OnStartup
-
OnClose
-

Attributes

-

getMusicPopularPlaylistById

Popular playlist by Id

OnInit
./lib/actions/getMusicPopularPlaylistById.js
OnStartup
-
OnClose
-

Attributes

-

getMusicPopularTracks

List of popular tracks for BBC Music. Filter by time, network, artist, playlist or programme.

OnInit
./lib/actions/getMusicPopularTracks.js
OnStartup
-
OnClose
-

Attributes

-

getMusicPopularTrackById

Popular Track for BBC Music

OnInit
./lib/actions/getMusicPopularTrackById.js
OnStartup
-
OnClose
-

Attributes

-

delete_my_categories_follows

OnInit
./lib/actions/delete_my_categories_follows.js
OnStartup
-
OnClose
-

Attributes

-

get_my_categories_follows

List of followed categories for a given user.

OnInit
./lib/actions/get_my_categories_follows.js
OnStartup
-
OnClose
-

Attributes

-

post_my_categories_follows

OnInit
./lib/actions/post_my_categories_follows.js
OnStartup
-
OnClose
-

Attributes

-

getMusicExport

Returns status of all previous third party export actions for a given BBC Music user.

OnInit
./lib/actions/getMusicExport.js
OnStartup
-
OnClose
-

Attributes

-

getMusicExportJobs

All items associated to a users export request

OnInit
./lib/actions/getMusicExportJobs.js
OnStartup
-
OnClose
-

Attributes

-

postMusicExportJob

Create Export Job for a user

OnInit
./lib/actions/postMusicExportJob.js
OnStartup
-
OnClose
-

Attributes

-

getMusicExportTracks

Retrieves vendor and status specific tracks

OnInit
./lib/actions/getMusicExportTracks.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedMusicFavourites

List of favourited tracks and clips for a given user for BBC Music.

OnInit
./lib/actions/getPersonalisedMusicFavourites.js
OnStartup
-
OnClose
-

Attributes

-

postPersonalisedMusicFavouritesBatch

Add multiple tracks and/or clips to a BBC Music user's favourites. N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/postPersonalisedMusicFavouritesBatch.js
OnStartup
-
OnClose
-

Attributes

-

putPersonalisedMusicFavouritesBatch

Update tracks or clips from a BBC Music user favourites. N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/putPersonalisedMusicFavouritesBatch.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedMusicFavouritesByType

List of favourited tracks or clips for a given user for BBC Music.

OnInit
./lib/actions/getPersonalisedMusicFavouritesByType.js
OnStartup
-
OnClose
-

Attributes

-

deletePersonalisedMusicFavouritesByTypeById

Delete track or clip from a BBC Music user favourites.

OnInit
./lib/actions/deletePersonalisedMusicFavouritesByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedMusicFavouritesByTypeById

Check to see if a single track or clip entity is in a users favourites - determines UX of add button.

OnInit
./lib/actions/getPersonalisedMusicFavouritesByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

postPersonalisedMusicFavouritesByTypeById

Add track or clip to a BBC Music user favourites. N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/postPersonalisedMusicFavouritesByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

putPersonalisedMusicFavouritesByTypeById

Update tracks or clips from a BBC Music user favourites. N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/putPersonalisedMusicFavouritesByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedMusicFollows

List of followed networks, categories, artists, playlists and genres for a given user for BBC Music.

OnInit
./lib/actions/getPersonalisedMusicFollows.js
OnStartup
-
OnClose
-

Attributes

-

postPersonalisedMusicFollowsBatch

Add networks, categories, artists, playlists, networks, genres or services in a users follows N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/postPersonalisedMusicFollowsBatch.js
OnStartup
-
OnClose
-

Attributes

-

putPersonalisedMusicFollowsBatch

Update networks, categories, artists, playlists, networks, genres or services in a users follows N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/putPersonalisedMusicFollowsBatch.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedMusicFollowsByType

List of followed networks, categories, artists, playlists, networks, genres, categories or services for a given BBC Music user.

OnInit
./lib/actions/getPersonalisedMusicFollowsByType.js
OnStartup
-
OnClose
-

Attributes

-

deletePersonalisedMusicFollowsByTypeById

Remove a single network, category, artist, playlist, network, genre or service entity is in a users follows

OnInit
./lib/actions/deletePersonalisedMusicFollowsByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedMusicFollowsByTypeById

Check to see if a single network, category, artist, playlist, network, genre or service entity is in a users follows - determines UX of add button.

OnInit
./lib/actions/getPersonalisedMusicFollowsByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

postPersonalisedMusicFollowsByTypeById

Add a single network, category, artist, playlist, network, genre or service entity is in a users follows N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/postPersonalisedMusicFollowsByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

putPersonalisedMusicFollowsByTypeById

Update a single network, category, artist, playlist, network, genre or service entity is in a users follows N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/putPersonalisedMusicFollowsByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

deleteMusicPreferencesExport

Remove export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.

OnInit
./lib/actions/deleteMusicPreferencesExport.js
OnStartup
-
OnClose
-

Attributes

-

getMusicPreferencesExport

Returns export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.

OnInit
./lib/actions/getMusicPreferencesExport.js
OnStartup
-
OnClose
-

Attributes

-

postMusicPreferencesExport

Create export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.

OnInit
./lib/actions/postMusicPreferencesExport.js
OnStartup
-
OnClose
-

Attributes

-

deleteMusicPreferencesExportVendor

Remove Vendor specific export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.

OnInit
./lib/actions/deleteMusicPreferencesExportVendor.js
OnStartup
-
OnClose
-

Attributes

-

getMusicPreferencesExportVendor

Returns vendor specific export preferences for a given BBC Music user.

OnInit
./lib/actions/getMusicPreferencesExportVendor.js
OnStartup
-
OnClose
-

Attributes

-

postMusicPreferencesExportVendor

Create Vendor specific export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.

OnInit
./lib/actions/postMusicPreferencesExportVendor.js
OnStartup
-
OnClose
-

Attributes

-

putMusicPreferencesExportVendor

Update vendor specific export preferences for a given BBC Music user.

OnInit
./lib/actions/putMusicPreferencesExportVendor.js
OnStartup
-
OnClose
-

Attributes

-

delete_my_networks_follows

OnInit
./lib/actions/delete_my_networks_follows.js
OnStartup
-
OnClose
-

Attributes

-

get_my_networks_follows

List of followed networks for a given user.

OnInit
./lib/actions/get_my_networks_follows.js
OnStartup
-
OnClose
-

Attributes

-

post_my_networks_follows

OnInit
./lib/actions/post_my_networks_follows.js
OnStartup
-
OnClose
-

Attributes

-

post_my_plays

OnInit
./lib/actions/post_my_plays.js
OnStartup
-
OnClose
-

Attributes

-

suggestContainer

Suggested Playspace Container

OnInit
./lib/actions/suggestContainer.js
OnStartup
-
OnClose
-

Attributes

-

getContainer

Playspace Container by ID

OnInit
./lib/actions/getContainer.js
OnStartup
-
OnClose
-

Attributes

-

getRecommendations

Recommended Programmes from the Audience Platforms' Recomendations Service

OnInit
./lib/actions/getRecommendations.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedRadioFavourites

List of favourited episodes and clips for a given user for iPlayer Radio. N.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode and Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification

OnInit
./lib/actions/getPersonalisedRadioFavourites.js
OnStartup
-
OnClose
-

Attributes

-

postPersonalisedRadioBatch

Add User favourites N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/postPersonalisedRadioBatch.js
OnStartup
-
OnClose
-

Attributes

-

putPersonalisedRadioBatch

Update user favourites N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/putPersonalisedRadioBatch.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedRadioFavouritesByType

List of followed 'clips' or 'episode' items for a given iPlayer Radio user N.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode and Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification

OnInit
./lib/actions/getPersonalisedRadioFavouritesByType.js
OnStartup
-
OnClose
-

Attributes

-

deletePersonalisedRadioByActivityTypeById

Remove User favourite

OnInit
./lib/actions/deletePersonalisedRadioByActivityTypeById.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedRadioByActivityTypeById

Check to see if a single clip or episode entity is in a users favourites - determines UX of add button. N.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode and Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification

OnInit
./lib/actions/getPersonalisedRadioByActivityTypeById.js
OnStartup
-
OnClose
-

Attributes

-

postPersonalisedRadioByActivityTypeById

Add User favourite N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/postPersonalisedRadioByActivityTypeById.js
OnStartup
-
OnClose
-

Attributes

-

putPersonalisedRadioByActivityTypeById

Update user favourite N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/putPersonalisedRadioByActivityTypeById.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedRadioFollows

List of favourited brands and series for a given user for iPlayer Radio. N.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode and Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification

OnInit
./lib/actions/getPersonalisedRadioFollows.js
OnStartup
-
OnClose
-

Attributes

-

postPersonalisedRadioFollowsBatch

Add 'brand' or 'series' items to a users iPlayer Radio follows N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/postPersonalisedRadioFollowsBatch.js
OnStartup
-
OnClose
-

Attributes

-

putPersonalisedRadioFollowsBatch

Update 'brands' or 'series' items from a users iPlayer Radio follows N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/putPersonalisedRadioFollowsBatch.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedRadioFollowsByType

List of followed 'brand' or 'series' items for a given iPlayer Radio user N.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode and Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification

OnInit
./lib/actions/getPersonalisedRadioFollowsByType.js
OnStartup
-
OnClose
-

Attributes

-

deletePersonalisedRadioFollowsByTypeById

Remove 'brand' or 'series' items from a users iPlayer Radio follows

OnInit
./lib/actions/deletePersonalisedRadioFollowsByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedRadioFollowsByTypeById

Check to see if a single brand or series entity is in a users follows - determines UX of add button.

OnInit
./lib/actions/getPersonalisedRadioFollowsByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

postPersonalisedRadioFollowsByTypeById

Add 'brand' or 'series' items from a users iPlayer Radio follows N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/postPersonalisedRadioFollowsByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

putPersonalisedRadioFollowsByTypeById

Update 'brand' or 'series' items from a users iPlayer Radio follows N.B. Any HTML tags submitted in metadata will be removed

OnInit
./lib/actions/putPersonalisedRadioFollowsByTypeById.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalisedRadioPlays

Returns mixed episode and clip plays for a given BBC iPlayer radio user. N.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode and Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification

OnInit
./lib/actions/getPersonalisedRadioPlays.js
OnStartup
-
OnClose
-

Attributes

-

getPodcasts

Retrieve all Podcasts

OnInit
./lib/actions/getPodcasts.js
OnStartup
-
OnClose
-

Attributes

-

getPodcastsFeatured

Retrieve featured podcasts

OnInit
./lib/actions/getPodcastsFeatured.js
OnStartup
-
OnClose
-

Attributes

-

getPodcastByPid

Retrieve data about the podcast with the supplied PID

OnInit
./lib/actions/getPodcastByPid.js
OnStartup
-
OnClose
-

Attributes

-

getPodcastEpisodes

Retrieve all episodes for a specific podcast

OnInit
./lib/actions/getPodcastEpisodes.js
OnStartup
-
OnClose
-

Attributes

-

getRadioNetworks

All iPlayer Radio networks - contains business logic for masterbrand and service relationships

OnInit
./lib/actions/getRadioNetworks.js
OnStartup
-
OnClose
-

Attributes

-

getPopularEpisodesClips

Retrieve Popular Episodes & Clips

OnInit
./lib/actions/getPopularEpisodesClips.js
OnStartup
-
OnClose
-

Attributes

-

getRadioProgrammes

Provides a paginated list of programmes by PID (brand, series, episode and clip). Accepts various filters and sorting methods. N.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode and Clip Summaries so we are defining results as an array of Programme Summary here. This will be resolved in V3 with full support for anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification

OnInit
./lib/actions/getRadioProgrammes.js
OnStartup
-
OnClose
-

Attributes

-

getRadioProgrammesByPid

Find programmes by PID (brand, series, episode and clip) N.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode and Clip Summaries so we are defining results as an array of Programme Summary here. This will be resolved in V3 with full support for anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification

OnInit
./lib/actions/getRadioProgrammesByPid.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment