| 1 | {"openapi":"3.0.0","info":{"description":"We encapsulate Radio & Music business logic for iPlayer Radio and BBC Music products on all platforms. We add value by reliably providing the right blend of metadata needed by clients.","title":"Radio & Music Services","version":"1.0.0","x-apisguru-categories":["media"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://upload.wikimedia.org/wikipedia/commons/thumb/6/63/BBC_Radio_logo.svg/140px-BBC_Radio_logo.svg.png"},"x-origin":[{"format":"swagger","url":"https://rms.api.bbc.co.uk/docs/swagger.json","version":"2.0"}],"x-providerName":"bbc.co.uk"},"tags":[{"name":"Experience"},{"description":"<a href=\"https://confluence.dev.bbc.co.uk/display/RMServices/Playspace+API+Client+Documetation\">Client Documentation</a>","name":"Playspace"},{"name":"Categories"},{"name":"Networks"},{"name":"Broadcasts"},{"name":"Collections"},{"name":"Podcasts"},{"name":"Programmes"},{"name":"Personalised Categories"},{"name":"Personalised Networks"},{"name":"Personalised Plays"},{"name":"Radio"},{"name":"Music"},{"name":"Music Export"}],"paths":{"/broadcasts":{"get":{"description":"All broadcasts\n","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Filter by Service ID. E.g. bbc_radio_fourfm","in":"query","name":"service_id","required":false,"schema":{"type":"string"}},{"description":"Filter by date. E.g. 2016-06-17","in":"query","name":"date","required":false,"schema":{"type":"string"}},{"description":"Sort by provided query. E.g. 'start_at' sorts in ascending order, and '-start_at' sorts in descending order","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["start_at","-start_at","end_at","-end_at"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastsResponse"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Broadcasts","tags":["Broadcasts"]}},"/broadcasts/latest":{"get":{"description":"Broadcasts for the current day\n","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Filter by Service ID. E.g. bbc_radio_fourfm","in":"query","name":"service_id","required":false,"schema":{"type":"string"}},{"description":"Filter what is on air. E.g. 'now' returns current programme being broadcasted.","in":"query","name":"on_air","required":false,"schema":{"type":"string","enum":["now","previous","next"]}},{"description":"Filter what will be on air next in minutes. E.g. '240' returns programmes broadcasted in the next four hurs","in":"query","name":"next","required":false,"schema":{"type":"string"}},{"description":"Filter what was on air previously in minutes. E.g. '240' returns programmes broadcasted in the previous four hurs","in":"query","name":"previous","required":false,"schema":{"type":"string"}},{"description":"Sort by provided query. E.g. 'start_at' sorts in ascending order, and '-start_at' sorts in descending order","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["start_at","-start_at","end_at","-end_at"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastsResponse"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Latest Broadcasts","tags":["Broadcasts"]}},"/broadcasts/{pid}":{"get":{"description":"Find broadcast by PID\n","operationId":"getBroadcastByPid","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastsResponse"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Broadcasts by PID","tags":["Broadcasts"]}},"/categories":{"get":{"description":"Retrieve Categories\n","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Filter by provided query. E.g. 'promoted' returns promoted categories","in":"query","name":"kind","required":false,"schema":{"type":"string","enum":["promoted"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryErrorResponse"}}}}},"summary":"List of categories","tags":["Categories"]}},"/categories/{id}":{"get":{"description":"Retrieve Categories by ID\n","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Retrieve information about the category. E.g. 'sport-football-europeanchampionship'","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryErrorResponse"}}}}},"summary":"Category by ID","tags":["Categories"]}},"/collections/{pid}/members":{"get":{"description":"Episodes and Clips from Collection\n","operationId":"getCollectionMembers","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgrammesResponse"}}}},"404":{"description":"Collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Collection Members","tags":["Collections"]}},"/experience/homepage":{"get":{"description":"Homepage Experience\n","operationId":"getExperienceHomepage","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Homepage Experience","tags":["Experience"]}},"/music/popular/artists":{"get":{"description":"List of Most Popular artists from BBC Music.\n","operationId":"getMusicPopularArtists","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given time period and now","in":"query","name":"since","required":false,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given 'since' and 'until' date params","in":"query","name":"until","required":false,"schema":{"type":"string"}},{"description":"In addition to the overall score, return a list of scores broken down by day N.B Must be used in conjunction with since and/or until and since is >= 31 days","in":"query","name":"decomposed","required":false,"schema":{"type":"boolean"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityArtists"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityError"}}}}},"summary":"Popular Artists","tags":["Music"],"servers":[{"url":"http://rms.api.bbc.co.uk/"}]}},"/music/popular/artists/{id}":{"get":{"description":"Popularity Artist By Id\n","operationId":"getMusicPopularArtistById","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given time period and now","in":"query","name":"since","required":false,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given 'since' and 'until' date params","in":"query","name":"until","required":false,"schema":{"type":"string"}},{"description":"In addition to the overall score, return a list of scores broken down by day N.B Must be used in conjunction with since and/or until and since is >= 31 days","in":"query","name":"decomposed","required":false,"schema":{"type":"boolean"}},{"description":"MusicBrainz Id - Used to get single resource score","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityArtists"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityError"}}}}},"summary":"Single Artist Popularity","tags":["Music"],"servers":[{"url":"http://rms.api.bbc.co.uk/"}]}},"/music/popular/playlists":{"get":{"description":"List of Most Popular playlists from BBC Music.\n","operationId":"getMusicPopularPlaylists","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given time period and now","in":"query","name":"since","required":false,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given 'since' and 'until' date params","in":"query","name":"until","required":false,"schema":{"type":"string"}},{"description":"In addition to the overall score, return a list of scores broken down by day N.B Must be used in conjunction with since and/or until and since is >= 31 days","in":"query","name":"decomposed","required":false,"schema":{"type":"boolean"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityPlaylists"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityError"}}}}},"summary":"Popular Playlists","tags":["Music"],"servers":[{"url":"http://rms.api.bbc.co.uk/"}]}},"/music/popular/playlists/{id}":{"get":{"description":"Popular playlist by Id\n","operationId":"getMusicPopularPlaylistById","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given time period and now","in":"query","name":"since","required":false,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given 'since' and 'until' date params","in":"query","name":"until","required":false,"schema":{"type":"string"}},{"description":"In addition to the overall score, return a list of scores broken down by day N.B Must be used in conjunction with since and/or until and since is >= 31 days","in":"query","name":"decomposed","required":false,"schema":{"type":"boolean"}},{"description":"BBC Music Playlist Id - Used to get single resource score","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityPlaylists"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityError"}}}}},"summary":"Single Playlist Popularity","tags":["Music"],"servers":[{"url":"http://rms.api.bbc.co.uk/"}]}},"/music/popular/tracks":{"get":{"description":"List of popular tracks for BBC Music. Filter by time, network, artist, playlist or programme.\n","operationId":"getMusicPopularTracks","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given time period and now","in":"query","name":"since","required":false,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given 'since' and 'until' date params","in":"query","name":"until","required":false,"schema":{"type":"string"}},{"description":"Return items with given Network ID","in":"query","name":"network","required":false,"schema":{"type":"string"}},{"description":"Items with given Programme Pid","in":"query","name":"programme","required":false,"schema":{"type":"string"}},{"description":"MusicBrainz artist ID","in":"query","name":"artist","required":false,"schema":{"type":"string"}},{"description":"In addition to the overall score, return a list of scores broken down by day N.B Must be used in conjunction with since and/or until and since is >= 31 days","in":"query","name":"decomposed","required":false,"schema":{"type":"boolean"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityTracks"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityError"}}}}},"summary":"Popular Tracks","tags":["Music"],"servers":[{"url":"http://rms.api.bbc.co.uk/"}]}},"/music/popular/tracks/{id}":{"get":{"description":"Popular Track for BBC Music\n","operationId":"getMusicPopularTrackById","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given time period and now","in":"query","name":"since","required":false,"schema":{"type":"string"}},{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given 'since' and 'until' date params","in":"query","name":"until","required":false,"schema":{"type":"string"}},{"description":"Return items with given Network ID","in":"query","name":"network","required":false,"schema":{"type":"string"}},{"description":"Items with given Programme Pid","in":"query","name":"programme","required":false,"schema":{"type":"string"}},{"description":"MusicBrainz artist ID","in":"query","name":"artist","required":false,"schema":{"type":"string"}},{"description":"In addition to the overall score, return a list of scores broken down by day N.B Must be used in conjunction with since and/or until and since is >= 31 days","in":"query","name":"decomposed","required":false,"schema":{"type":"boolean"}},{"description":"BBC Music Track Id - Used to get single resource score","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityTracks"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicPopularityError"}}}}},"summary":"Single Track Popularity","tags":["Music"],"servers":[{"url":"http://rms.api.bbc.co.uk/"}]}},"/my/categories/follows":{"delete":{"parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_1"}}},"required":true},"responses":{"202":{"description":"Request successfully sent to UAS."},"400":{"description":"The request was malformed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Unfollow category","tags":["Personalised Categories"]},"get":{"description":"List of followed categories for a given user.\n","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedCategoriesResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"List of followed categories","tags":["Personalised Categories"]},"post":{"parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body"}}},"required":true},"responses":{"202":{"description":"Request successfully sent to UAS."},"400":{"description":"The request was malformed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Follow category","tags":["Personalised Categories"]}},"/my/music/export":{"get":{"description":"Returns status of all previous third party export actions for a given BBC Music user.\n","operationId":"getMusicExport","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportJob"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Exports","tags":["Music Export"]}},"/my/music/exports/jobs":{"get":{"description":"All items associated to a users export request\n","operationId":"getMusicExportJobs","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Boolean age check","in":"query","name":"over16","required":true,"schema":{"type":"boolean"}},{"description":"Specify Vendor Jobs","in":"query","name":"vendor","required":false,"schema":{"type":"string","enum":["spotify","deezer","youtube","itunes"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportJob"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Jobs","tags":["Music Export"]},"post":{"description":"Create Export Job for a user\n","operationId":"postMusicExportJob","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Boolean age check","in":"query","name":"over16","required":true,"schema":{"type":"boolean"}},{"description":"Specify Vendor Jobs","in":"query","name":"vendor","required":false,"schema":{"type":"string","enum":["spotify","deezer","youtube","itunes"]}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/MusicExportJob"},"type":"array"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Jobs","tags":["Music Export"]}},"/my/music/exports/tracks":{"get":{"description":"Retrieves vendor and status specific tracks\n","operationId":"getMusicExportTracks","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Boolean age check","in":"query","name":"over16","required":true,"schema":{"type":"boolean"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Specify Vendor Tracks","in":"query","name":"vendor","required":false,"schema":{"type":"string","enum":["spotify","deezer","youtube","itunes"]}},{"description":"Specify Track status","in":"query","name":"status","required":false,"schema":{"type":"string","enum":["failed","done","pending"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportJob"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Tracks","tags":["Music Export"]}},"/my/music/favourites":{"get":{"description":"List of favourited tracks and clips for a given user for BBC Music.\n","operationId":"getPersonalisedMusicFavourites","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Filters activities based on the type of action","in":"query","name":"action","required":false,"schema":{"type":"string","enum":["favourited","unfavourited"]}},{"description":"Omits music data from the response, defaults to true","in":"query","name":"music-data","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Favourite Tracks or Clips","tags":["Music"]},"post":{"description":"Add multiple tracks and/or clips to a BBC Music user's favourites.\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"postPersonalisedMusicFavouritesBatch","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedMusicBatchRequestArray"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Favourite Tracks or Clips","tags":["Music"]},"put":{"description":"Update tracks or clips from a BBC Music user favourites.\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"putPersonalisedMusicFavouritesBatch","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedMusicBatchRequestArray"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Favourite Tracks or Clips","tags":["Music"]}},"/my/music/favourites/{type}":{"get":{"description":"List of favourited tracks or clips for a given user for BBC Music.\n","operationId":"getPersonalisedMusicFavouritesByType","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music favourite types: Clips or Tracks","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","tracks"]}},{"description":"Filters activities based on the type of action","in":"query","name":"action","required":false,"schema":{"type":"string","enum":["favourited","unfavourited"]}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Favourite Tracks or Clips by Type","tags":["Music"]}},"/my/music/favourites/{type}/{id}":{"delete":{"description":"Delete track or clip from a BBC Music user favourites.\n","operationId":"deletePersonalisedMusicFavouritesByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music favourite types: Clips or Tracks","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","tracks"]}},{"description":"Clip PID or Track ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Favourite Track or Clip","tags":["Music"]},"get":{"description":"Check to see if a single track or clip entity is in a users favourites - determines UX of add button.\n","operationId":"getPersonalisedMusicFavouritesByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music favourite types: Clips or Tracks","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","tracks"]}},{"description":"Clip PID or Track ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Favourite Track or Clip","tags":["Music"]},"post":{"description":"Add track or clip to a BBC Music user favourites.\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"postPersonalisedMusicFavouritesByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music favourite types: Clips or Tracks","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","tracks"]}},{"description":"Clip PID or Track ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedMusicRequest2"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Favourite Track or Clip","tags":["Music"]},"put":{"description":"Update tracks or clips from a BBC Music user favourites.\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"putPersonalisedMusicFavouritesByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music favourite types: Clips or Tracks","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","tracks"]}},{"description":"Clip PID or Track ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedMusicRequest2"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Favourite Track or Clip","tags":["Music"]}},"/my/music/follows":{"get":{"description":"List of followed networks, categories, artists, playlists and genres for a given user for BBC Music.\n","operationId":"getPersonalisedMusicFollows","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Filters activities based on the type of action","in":"query","name":"action","required":false,"schema":{"type":"string","enum":["followed","unfollowed"]}},{"description":"Omits music data from the response, defaults to true","in":"query","name":"music-data","required":false,"schema":{"type":"boolean"}},{"description":"Specify context to be passed to Music API","in":"query","name":"music_context","required":false,"schema":{"type":"string","enum":["events","ivote","music","musicplaylist","programmes","radio","unknown"]}},{"description":"Specify location to be passed to Music API","in":"query","name":"music_within_uk","required":false,"schema":{"type":"boolean"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Followed Networks, Categories, Artists, Playlists and Genres","tags":["Music"]},"post":{"description":"Add networks, categories, artists, playlists, networks, genres or services in a users follows\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"postPersonalisedMusicFollowsBatch","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Filters activities based on the type of action","in":"query","name":"action","required":false,"schema":{"type":"string","enum":["followed","unfollowed"]}},{"description":"Omits music data from the response, defaults to true","in":"query","name":"music-data","required":false,"schema":{"type":"boolean"}},{"description":"Specify context to be passed to Music API","in":"query","name":"music_context","required":false,"schema":{"type":"string","enum":["events","ivote","music","musicplaylist","programmes","radio","unknown"]}},{"description":"Specify location to be passed to Music API","in":"query","name":"music_within_uk","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedMusicBatchRequestArray2"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Followed Networks, Categories, Artists, Playlists and Genres","tags":["Music"]},"put":{"description":"Update networks, categories, artists, playlists, networks, genres or services in a users follows\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"putPersonalisedMusicFollowsBatch","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Filters activities based on the type of action","in":"query","name":"action","required":false,"schema":{"type":"string","enum":["followed","unfollowed"]}},{"description":"Omits music data from the response, defaults to true","in":"query","name":"music-data","required":false,"schema":{"type":"boolean"}},{"description":"Specify context to be passed to Music API","in":"query","name":"music_context","required":false,"schema":{"type":"string","enum":["events","ivote","music","musicplaylist","programmes","radio","unknown"]}},{"description":"Specify location to be passed to Music API","in":"query","name":"music_within_uk","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedMusicBatchRequestArray2"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Followed Networks, Categories, Artists, Playlists and Genres","tags":["Music"]}},"/my/music/follows/{type}":{"get":{"description":"List of followed networks, categories, artists, playlists, networks, genres, categories or services for a given BBC Music user.\n","operationId":"getPersonalisedMusicFollowsByType","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music follows types: Playlists, Services, Genres & Artists","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["playlists","services","networks","genres","categories","artists"]}},{"description":"Filters activities based on the type of action","in":"query","name":"action","required":false,"schema":{"type":"string","enum":["followed","unfollowed"]}},{"description":"Omits music data from the response, defaults to true","in":"query","name":"music-data","required":false,"schema":{"type":"boolean"}},{"description":"Specify context to be passed to Music API","in":"query","name":"music_context","required":false,"schema":{"type":"string","enum":["events","ivote","music","musicplaylist","programmes","radio","unknown"]}},{"description":"Specify location to be passed to Music API","in":"query","name":"music_within_uk","required":false,"schema":{"type":"boolean"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Followed Networks, Categories, Artists, Playlists and Genres by Type","tags":["Music"]}},"/my/music/follows/{type}/{id}":{"delete":{"description":"Remove a single network, category, artist, playlist, network, genre or service entity is in a users follows\n","operationId":"deletePersonalisedMusicFollowsByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music follows types: Playlists, Services, Genres & Artists","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["playlists","services","networks","genres","categories","artists"]}},{"description":"Playlists, Services, Networks, Genres, Categories or Artists ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Omits music data from the response, defaults to true","in":"query","name":"music-data","required":false,"schema":{"type":"boolean"}},{"description":"Specify context to be passed to Music API","in":"query","name":"music_context","required":false,"schema":{"type":"string","enum":["events","ivote","music","musicplaylist","programmes","radio","unknown"]}},{"description":"Specify location to be passed to Music API","in":"query","name":"music_within_uk","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Followed Network, Category, Artist, Playlist and Genre","tags":["Music"]},"get":{"description":"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.\n","operationId":"getPersonalisedMusicFollowsByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music follows types: Playlists, Services, Genres & Artists","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["playlists","services","networks","genres","categories","artists"]}},{"description":"Playlists, Services, Networks, Genres, Categories or Artists ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Omits music data from the response, defaults to true","in":"query","name":"music-data","required":false,"schema":{"type":"boolean"}},{"description":"Specify context to be passed to Music API","in":"query","name":"music_context","required":false,"schema":{"type":"string","enum":["events","ivote","music","musicplaylist","programmes","radio","unknown"]}},{"description":"Specify location to be passed to Music API","in":"query","name":"music_within_uk","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Followed Network, Category, Artist, Playlist and Genre","tags":["Music"]},"post":{"description":"Add a single network, category, artist, playlist, network, genre or service entity is in a users follows\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"postPersonalisedMusicFollowsByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music follows types: Playlists, Services, Genres & Artists","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["playlists","services","networks","genres","categories","artists"]}},{"description":"Playlists, Services, Networks, Genres, Categories or Artists ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Omits music data from the response, defaults to true","in":"query","name":"music-data","required":false,"schema":{"type":"boolean"}},{"description":"Specify context to be passed to Music API","in":"query","name":"music_context","required":false,"schema":{"type":"string","enum":["events","ivote","music","musicplaylist","programmes","radio","unknown"]}},{"description":"Specify location to be passed to Music API","in":"query","name":"music_within_uk","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedMusicRequest"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Followed Network, Category, Artist, Playlist and Genre","tags":["Music"]},"put":{"description":"Update a single network, category, artist, playlist, network, genre or service entity is in a users follows\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"putPersonalisedMusicFollowsByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Music follows types: Playlists, Services, Genres & Artists","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["playlists","services","networks","genres","categories","artists"]}},{"description":"Playlists, Services, Networks, Genres, Categories or Artists ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Omits music data from the response, defaults to true","in":"query","name":"music-data","required":false,"schema":{"type":"boolean"}},{"description":"Specify context to be passed to Music API","in":"query","name":"music_context","required":false,"schema":{"type":"string","enum":["events","ivote","music","musicplaylist","programmes","radio","unknown"]}},{"description":"Specify location to be passed to Music API","in":"query","name":"music_within_uk","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedMusicRequest"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicErrorResponse"}}}}},"summary":"Followed Network, Category, Artist, Playlist and Genre","tags":["Music"]}},"/my/music/preferences/export":{"delete":{"description":"Remove export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.\n","operationId":"deleteMusicPreferencesExport","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Preferences","tags":["Music Export"]},"get":{"description":"Returns export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.\n","operationId":"getMusicPreferencesExport","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportPreferencesResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Preferences","tags":["Music Export"]},"post":{"description":"Create export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.\n","operationId":"postMusicPreferencesExport","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/MusicExportPreferences"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportSuccess"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Preferences","tags":["Music Export"]}},"/my/music/preferences/export/{vendor}":{"delete":{"description":"Remove Vendor specific export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.\n","operationId":"deleteMusicPreferencesExportVendor","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported 3rd Party Vendor","in":"path","name":"vendor","required":true,"schema":{"type":"string","enum":["spotify","deezer","youtube","itunes"]}}],"responses":{"200":{"description":"OK"},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Vendor Preferences","tags":["Music Export"]},"get":{"description":"Returns vendor specific export preferences for a given BBC Music user.\n","operationId":"getMusicPreferencesExportVendor","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported 3rd Party Vendor","in":"path","name":"vendor","required":true,"schema":{"type":"string","enum":["spotify","deezer","youtube","itunes"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportPreferencesResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Vendor Preferences","tags":["Music Export"]},"post":{"description":"Create Vendor specific export preferences (e.g. 3rd party vendors, partner id's) for a given BBC Music user.\n","operationId":"postMusicPreferencesExportVendor","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported 3rd Party Vendor","in":"path","name":"vendor","required":true,"schema":{"type":"string","enum":["spotify","deezer","youtube","itunes"]}}],"requestBody":{"$ref":"#/components/requestBodies/MusicExportPreferences"},"responses":{"200":{"description":"OK"},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Vendor Preferences","tags":["Music Export"]},"put":{"description":"Update vendor specific export preferences for a given BBC Music user.\n","operationId":"putMusicPreferencesExportVendor","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported 3rd Party Vendor","in":"path","name":"vendor","required":true,"schema":{"type":"string","enum":["spotify","deezer","youtube","itunes"]}}],"requestBody":{"$ref":"#/components/requestBodies/MusicExportPreferences"},"responses":{"200":{"description":"OK"},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportErrorResponse"}}}}},"summary":"Music Export Vendor Preferences","tags":["Music Export"]}},"/my/networks/follows":{"delete":{"parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_3"}}},"required":true},"responses":{"202":{"description":"Request successfully sent to UAS."},"400":{"description":"The request was malformed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Unfollow network","tags":["Personalised Networks"]},"get":{"description":"List of followed networks for a given user.\n","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedNetworksResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"List of followed networks","tags":["Personalised Networks"]},"post":{"parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_2"}}},"required":true},"responses":{"202":{"description":"Request successfully sent to UAS."},"400":{"description":"The request was malformed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Follow network","tags":["Personalised Networks"]}},"/my/plays":{"post":{"parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_4"}}},"required":true},"responses":{"202":{"description":"Request successfully sent to UAS."},"400":{"description":"The request was malformed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Write Play Event","tags":["Personalised Plays"]}},"/my/playspace/containers/suggested":{"get":{"description":"Suggested Playspace Container\n","operationId":"suggestContainer","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Clip or Episode PID of the previous or first content item in the Playspace stream.","in":"query","name":"previous_pid","required":true,"schema":{"type":"string"}},{"description":"Container ID of the previous container in the Playspace stream.","in":"query","name":"previous_container","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayspaceContainer"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Suggested Playspace Container","tags":["Playspace"]}},"/my/playspace/containers/{id}":{"get":{"description":"Playspace Container by ID\n","operationId":"getContainer","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Playspace Container ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayspaceContainer"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No Playspace container with given ID could be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Playspace Container by ID","tags":["Playspace"]}},"/my/programmes/recommendations":{"get":{"description":"Recommended Programmes from the Audience Platforms' Recomendations Service\n","operationId":"getRecommendations","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Only return available results for the web/mobile.","in":"query","name":"rights","required":true,"schema":{"type":"string","enum":["web","mobile"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgrammesResponse"}}}},"401":{"description":"There was an error with the supplied `Authorization` header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Recommended Programmes","tags":["Programmes"]}},"/my/radio/favourites":{"get":{"description":"List of favourited episodes and clips for a given user for iPlayer Radio.\n\nN.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode\nand Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for\n anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification\n","operationId":"getPersonalisedRadioFavourites","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Sort order for Personalised Radio results","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["programme_titles","available_from_date","available_to_date"]}},{"description":"Include items which have been 'soft' unfavourited in response. I.e items with UAS type of 'unfavourited'","in":"query","name":"show_all_activity","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Favourite Episodes and Clips","tags":["Radio"]},"post":{"description":"Add User favourites\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"postPersonalisedRadioBatch","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedRadioBatchRequestArray"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Favourite Episodes and Clips","tags":["Radio"]},"put":{"description":"Update user favourites\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"putPersonalisedRadioBatch","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedRadioBatchRequestArray"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Favourite Episodes and Clips","tags":["Radio"]}},"/my/radio/favourites/{type}":{"get":{"description":"List of followed 'clips' or 'episode' items for a given iPlayer Radio user\n\nN.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode\nand Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for\n anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification\n","operationId":"getPersonalisedRadioFavouritesByType","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio favourite types: Clips or Episodes","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","episodes"]}},{"description":"Sort order for Personalised Radio results","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["programme_titles","available_from_date","available_to_date"]}},{"description":"Include items which have been 'soft' unfavourited in response. I.e items with UAS type of 'unfavourited'","in":"query","name":"show_all_activity","required":false,"schema":{"type":"boolean"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Favourite Episodes and Clips by Type","tags":["Radio"]}},"/my/radio/favourites/{type}/{pid}":{"delete":{"description":"Remove User favourite\n","operationId":"deletePersonalisedRadioByActivityTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio favourite types: Clips or Episodes","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","episodes"]}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Favourite Episode or Clip","tags":["Radio"]},"get":{"description":"Check to see if a single clip or episode entity is in a users favourites - determines UX of add button.\n\nN.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode\nand Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for\n anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification\n","operationId":"getPersonalisedRadioByActivityTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio favourite types: Clips or Episodes","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","episodes"]}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}},{"description":"Include items which have been 'soft' unfavourited in response. I.e items with UAS type of 'unfavourited'","in":"query","name":"show_all_activity","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Favourite Episode or Clip","tags":["Radio"]},"post":{"description":"Add User favourite\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"postPersonalisedRadioByActivityTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio favourite types: Clips or Episodes","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","episodes"]}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedRadioRequest"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Favourite Episode or Clip","tags":["Radio"]},"put":{"description":"Update user favourite\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"putPersonalisedRadioByActivityTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio favourite types: Clips or Episodes","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["clips","episodes"]}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedRadioRequest"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Favourite Episode or Clip","tags":["Radio"]}},"/my/radio/follows":{"get":{"description":"List of favourited brands and series for a given user for iPlayer Radio.\n\nN.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode\nand Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for\n anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification\n","operationId":"getPersonalisedRadioFollows","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Sort order for Personalised Radio results","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["programme_titles","available_from_date","available_to_date"]}},{"description":"Include items which have been 'soft' unfollowed in response. I.e items with UAS type of 'unfollowed'","in":"query","name":"show_all_activity","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Followed Brands and Series","tags":["Radio"]},"post":{"description":"Add 'brand' or 'series' items to a users iPlayer Radio follows\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"postPersonalisedRadioFollowsBatch","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedRadioBatchRequestArray2"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Followed Brands and Series","tags":["Radio"]},"put":{"description":"Update 'brands' or 'series' items from a users iPlayer Radio follows\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"putPersonalisedRadioFollowsBatch","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedRadioBatchRequestArray2"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Followed Brands and Series","tags":["Radio"]}},"/my/radio/follows/{type}":{"get":{"description":"List of followed 'brand' or 'series' items for a given iPlayer Radio user\n\nN.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode\nand Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for\n anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification\n","operationId":"getPersonalisedRadioFollowsByType","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio follows types: Brands or Series","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["brands","series"]}},{"description":"Sort order for Personalised Radio results","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["programme_titles","available_from_date","available_to_date"]}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Include items which have been 'soft' unfollowed in response. I.e items with UAS type of 'unfollowed'","in":"query","name":"show_all_activity","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Followed Brands or Series by Type","tags":["Radio"]}},"/my/radio/follows/{type}/{pid}":{"delete":{"description":"Remove 'brand' or 'series' items from a users iPlayer Radio follows\n","operationId":"deletePersonalisedRadioFollowsByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio follows types: Brands or Series","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["brands","series"]}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Followed Brand or Series","tags":["Radio"]},"get":{"description":"Check to see if a single brand or series entity is in a users follows - determines UX of add button.\n","operationId":"getPersonalisedRadioFollowsByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio follows types: Brands or Series","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["brands","series"]}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Followed Brand or Series","tags":["Radio"]},"post":{"description":"Add 'brand' or 'series' items from a users iPlayer Radio follows\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"postPersonalisedRadioFollowsByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio follows types: Brands or Series","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["brands","series"]}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedRadioRequest2"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Followed Brand or Series","tags":["Radio"]},"put":{"description":"Update 'brand' or 'series' items from a users iPlayer Radio follows\n\nN.B. Any HTML tags submitted in metadata will be removed\n","operationId":"putPersonalisedRadioFollowsByTypeById","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Supported Radio follows types: Brands or Series","in":"path","name":"type","required":true,"schema":{"type":"string","enum":["brands","series"]}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PersonalisedRadioRequest2"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioSuccessResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Followed Brand or Series","tags":["Radio"]}},"/my/radio/plays":{"get":{"description":"Returns mixed episode and clip plays for a given BBC iPlayer radio user.\n\nN.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode\nand Clip Summaries so we are defining data as a Programme Summary here. This will be resolved in V3 with full support for\n anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification\n","operationId":"getPersonalisedRadioPlays","parameters":[{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Sort order for Personalised Radio results","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["programme_titles","available_from_date","available_to_date"]}},{"description":"Include expired/unavailable items","in":"query","name":"show_all_activity","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse"}}}}},"summary":"Played Episode or Clip","tags":["Radio"]}},"/podcasts":{"get":{"description":"Retrieve all Podcasts\n","operationId":"getPodcasts","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Sort order for Podcasts results","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["title","-title","available_from_date","-available_from_date"]}},{"description":"Network Master Brand ID (mid)","in":"query","name":"network","required":false,"schema":{"type":"string"}},{"description":"Network URL key","in":"query","name":"network_url_key","required":false,"schema":{"type":"string"}},{"description":"Category ID","in":"query","name":"category","required":false,"schema":{"type":"string"}},{"description":"Search query String","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Local, National or Regional Coverage","in":"query","name":"coverage","required":false,"schema":{"type":"string","enum":["local","national","regional"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PodcastsResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PodcastErrorResponse"}}}}},"summary":"All Podcasts","tags":["Podcasts"]}},"/podcasts/featured":{"get":{"description":"Retrieve featured podcasts\n","operationId":"getPodcastsFeatured","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PodcastsFeaturedResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PodcastErrorResponse"}}}}},"summary":"Featured Podcasts","tags":["Podcasts"]}},"/podcasts/{pid}":{"get":{"description":"Retrieve data about the podcast with the supplied PID\n","operationId":"getPodcastByPid","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PodcastsResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PodcastErrorResponse"}}}}},"summary":"Podcast","tags":["Podcasts"]}},"/podcasts/{pid}/episodes":{"get":{"description":"Retrieve all episodes for a specific podcast\n","operationId":"getPodcastEpisodes","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}},{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PodcastEpisodesResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PodcastErrorResponse"}}}}},"summary":"Podcast Episodes","tags":["Podcasts"]}},"/radio/networks.json":{"get":{"description":"All iPlayer Radio networks - contains business logic for masterbrand and service relationships\n","operationId":"getRadioNetworks","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Returns all networks needed for iPlayer Radio responsive web navigation","in":"query","name":"preset","required":false,"schema":{"type":"boolean"}},{"description":"Returns all networks available internationally","in":"query","name":"international","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworksResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RadioErrorResponse"}}}}},"summary":"Networks","tags":["Networks"]}},"/radio/popular":{"get":{"description":"Retrieve Popular Episodes & Clips\n","operationId":"getPopularEpisodesClips","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Programme type required. Accepts comma separated values","in":"query","name":"type","required":false,"schema":{"type":"string","enum":["episode","clip","episode,clip"]}},{"description":"Filter by deduplication rule. E.g. 'tleo' returns programmes with distinct top level episode objects","in":"query","name":"distinct","required":false,"schema":{"type":"string","enum":["tleo"]}},{"description":"Filter by network master brand ID (mid). Accepts comma separated values","in":"query","name":"network","required":false,"schema":{"type":"string"}},{"description":"Filter by network URL key. Accepts comma separated values","in":"query","name":"network_url_key","required":false,"schema":{"type":"string"}},{"description":"Filter by category. Accepts comma separated values","in":"query","name":"category","required":false,"schema":{"type":"string"}},{"description":"Filter by format. Accepts comma separated values","in":"query","name":"format","required":false,"schema":{"type":"string"}},{"description":"Filter by group. Accepts comma separated values","in":"query","name":"group","required":false,"schema":{"type":"string","enum":["tv","radio","tv,radio"]}},{"description":"Filter by programme media type. Accepts comma separated values","in":"query","name":"media_type","required":false,"schema":{"type":"string","enum":["audio","video","audio,video"]}},{"description":"Filter by container. Accepts any pid e.g. brand,series,episode","in":"query","name":"container","required":false,"schema":{"type":"string"}},{"description":"Filter by media set name. Accepts comma separated combinations of the following: pc,mobile-download,android-download-high,apple-ios-download-high,mobile-cellular-main,mobile-phone-main,iptv-all","in":"query","name":"media_set","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{},"enum":["pc","mobile-download","android-download-high","apple-ios-download-high","mobile-cellular-main","mobile-phone-main","iptv-all"]}},{"description":"Search query String","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopularResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopularErrorResponse"}}}}},"summary":"Popular Episodes & Clips","tags":["Programmes"]}},"/radio/programmes":{"get":{"description":"Provides a paginated list of programmes by PID (brand, series, episode and clip). Accepts various filters and sorting methods.\n\nN.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode\nand Clip Summaries so we are defining results as an array of Programme Summary here. This will be resolved in V3 with full support for\n anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification\n","operationId":"getRadioProgrammes","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"Filter by provided query. E.g. 'tleo' returns top level objects, ie. brands, orphaned series, and orphaned episodes","in":"query","name":"kind","required":false,"schema":{"type":"string","enum":["tleo"]}},{"description":"Filter by network master brand ID (mid). Accepts comma separated values","in":"query","name":"network","required":false,"schema":{"type":"string"}},{"description":"Filter by network URL key. Accepts comma separated values","in":"query","name":"network_url_key","required":false,"schema":{"type":"string"}},{"description":"Filter by category id. Accepts comma separated values. See /category endpoint below for the type of response provided","in":"query","name":"category","required":false,"schema":{"type":"string"}},{"description":"Sort by provided query. E.g. 'title' sorts in ascending order, and -title sorts in descending order","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["available_from_date","-available_from_date","title","-title"]}},{"description":"Filter by container. Accepts any brand or series pid","in":"query","name":"container","required":false,"schema":{"type":"string"}},{"description":"Filter by programme type. Accepts comma separated values","in":"query","name":"type","required":false,"schema":{"type":"string","enum":["brand","series","episode","clip","episode,clip"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgrammesResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RadioErrorResponse"}}}}},"summary":"Radio programmes","tags":["Programmes"]}},"/radio/programmes/{pid}":{"get":{"description":"Find programmes by PID (brand, series, episode and clip)\n\nN.B. Swagger schemas cannot currently handle multiple combinations of object in an array i.e. a mix of Episode\nand Clip Summaries so we are defining results as an array of Programme Summary here. This will be resolved in V3 with full support for\n anyOf https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification\n","operationId":"getRadioProgrammesByPid","parameters":[{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgrammesResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RadioErrorResponse"}}}}},"summary":"Available radio programme by Pid","tags":["Programmes"]}}},"servers":[{"url":"https://rms.api.bbc.co.uk/"}],"components":{"parameters":{"Authorization":{"description":"Bearer OAUTH_TOKEN","in":"header","name":"Authorization","required":true,"schema":{"type":"string","default":"Bearer OAUTH_TOKEN"}},"X-API-Key":{"description":"API_KEY","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string"}},"X-Authentication-Provider":{"description":"Authentication type","in":"header","name":"X-Authentication-Provider","required":true,"schema":{"type":"string","default":"idv5"}},"artist":{"description":"MusicBrainz artist ID","in":"query","name":"artist","required":false,"schema":{"type":"string"}},"category":{"description":"Category ID","in":"query","name":"category","required":false,"schema":{"type":"string"}},"coverage":{"description":"Local, National or Regional Coverage","in":"query","name":"coverage","required":false,"schema":{"type":"string","enum":["local","national","regional"]}},"decomposed":{"description":"In addition to the overall score, return a list of scores broken down by day N.B Must be used in conjunction with since and/or until and since is >= 31 days","in":"query","name":"decomposed","required":false,"schema":{"type":"boolean"}},"limit":{"description":"Paginated results limit","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},"network":{"description":"Return items with given Network ID","in":"query","name":"network","required":false,"schema":{"type":"string"}},"offset":{"description":"Paginated results offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},"over16":{"description":"Boolean age check","in":"query","name":"over16","required":true,"schema":{"type":"boolean"}},"pid":{"description":"pid","in":"path","name":"pid","required":true,"schema":{"type":"string"}},"programme":{"description":"Items with given Programme Pid","in":"query","name":"programme","required":false,"schema":{"type":"string"}},"q":{"description":"Search query String","in":"query","name":"q","required":false,"schema":{"type":"string"}},"rights":{"description":"Only return available results for the web/mobile.","in":"query","name":"rights","required":true,"schema":{"type":"string","enum":["web","mobile"]}},"since":{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given time period and now","in":"query","name":"since","required":false,"schema":{"type":"string"}},"sort":{"description":"Sort order for Podcasts results","in":"query","name":"sort","required":false,"schema":{"type":"string","enum":["title","-title","available_from_date","-available_from_date"]}},"until":{"description":"ISO 8601 Date yyyy-mm-dd. Returns items between given 'since' and 'until' date params","in":"query","name":"until","required":false,"schema":{"type":"string"}}},"requestBodies":{"PersonalisedRadioBatchRequestArray":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PersonalisedRadioBatchRequest"},"type":"array"}}},"description":"Action favourited or unfavourited","required":true},"PersonalisedMusicRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicRequest"}}},"description":"Action followed or unfollowed","required":true},"PersonalisedMusicBatchRequestArray":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PersonalisedMusicBatchRequest"},"type":"array"}}},"description":"Action favourited or unfavourited","required":true},"PersonalisedMusicRequest2":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedMusicRequest"}}},"description":"Action favourited or unfavourited","required":true},"PersonalisedMusicBatchRequestArray2":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PersonalisedMusicBatchRequest"},"type":"array"}}},"description":"Action followed or unfollowed","required":true},"MusicExportPreferences":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicExportPreferences"}}},"required":true},"PersonalisedRadioRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioRequest"}}},"description":"Action favourited or unfavourited","required":true},"PersonalisedRadioBatchRequestArray2":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PersonalisedRadioBatchRequest"},"type":"array"}}},"description":"Action followed or unfollowed","required":true},"PersonalisedRadioRequest2":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalisedRadioRequest"}}},"description":"Action followed or unfollowed","required":true}},"schemas":{"AncestorSummary":{"properties":{"ancestor_type":{"type":"string"},"id":{"type":"string"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"titles":{"$ref":"#/components/schemas/AncestorTitles"},"type":{"type":"string"}},"required":["ancestor_type","id","images","titles","type"],"type":"object"},"AncestorTitles":{"properties":{"title":{"type":"string"},"type":{"type":"string"}},"required":["title","type"],"type":"object"},"AvailableVersions":{"properties":{"available":{"type":"string"},"available_from_date":{"type":"string"},"available_to_date":{"type":"string"},"duration":{"type":"string"},"has_guidance":{"type":"boolean"},"media_set":{"type":"string"},"type":{"type":"string"},"version_pid":{"type":"string"},"version_type":{"type":"string"}},"required":["available","available_from_date","available_to_date","duration","has_guidance","media_set","type","version_pid","version_type"],"type":"object"},"Body":{"properties":{"category_id":{"type":"string"},"platform":{"enum":["responsiveweb","app"],"type":"string"}},"required":["category_id","platform"],"type":"object"},"Body_1":{"properties":{"category_id":{"type":"string"},"platform":{"enum":["responsiveweb","app"],"type":"string"}},"required":["category_id","platform"],"type":"object"},"Body_2":{"properties":{"platform":{"enum":["responsiveweb","app"],"type":"string"},"service_id":{"type":"string"}},"required":["platform","service_id"],"type":"object"},"Body_3":{"properties":{"platform":{"enum":["responsiveweb","app"],"type":"string"},"service_id":{"type":"string"}},"required":["platform","service_id"],"type":"object"},"Body_4":{"properties":{"action":{"enum":["started","ended","paused","heartbeat"],"type":"string"},"elapsed_time":{"type":"integer"},"pid":{"type":"string"},"resource_type":{"enum":["episode","clip"],"type":"string"},"version_pid":{"type":"string"}},"required":["action","elapsed_time","pid","resource_type","version_pid"],"type":"object"},"BrandSummary":{"properties":{"available_versions":{"items":{"$ref":"#/components/schemas/AvailableVersions"},"type":"array"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"latest_available_episodes":{"items":{"$ref":"#/components/schemas/EpisodeSummary"},"type":"array"},"network_summary":{"$ref":"#/components/schemas/NetworkSummary"},"pid":{"type":"string"},"short_synopsis":{"type":"string"},"titles":{"$ref":"#/components/schemas/ProgrammeTitles"},"total_available_episodes":{"type":"integer"},"type":{"enum":["brand_summary"],"type":"string"}},"required":["images","latest_available_episodes","network_summary","pid","short_synopsis","titles","total_available_episodes","type"],"type":"object"},"Broadcast":{"properties":{"duration":{"type":"integer"},"end":{"type":"string"},"is_audio_described":{"type":"boolean"},"is_blanked":{"type":"boolean"},"is_critical":{"type":"boolean"},"is_live":{"type":"boolean"},"is_repeat":{"type":"boolean"},"is_webcast":{"type":"boolean"},"pid":{"type":"string"},"programme":{"$ref":"#/components/schemas/ProgrammeSummary"},"service_id":{"type":"string"},"start":{"type":"string"},"type":{"type":"string"},"version_pid":{"type":"string"}},"required":["duration","end","is_audio_described","is_blanked","is_critical","is_live","is_repeat","is_webcast","pid","service_id","start","type","version_pid"],"type":"object"},"BroadcastsResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"integer"},"offset":{"type":"integer"},"results":{"items":{"$ref":"#/components/schemas/Broadcast"},"type":"array"},"total":{"type":"integer"}},"required":["$schema","limit","offset","results","total"],"type":"object"},"CategoriesResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"integer"},"offset":{"type":"integer"},"results":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"},"total":{"type":"integer"}},"required":["$schema","limit","offset","results","total"],"type":"object"},"Category":{"properties":{"category_type":{"type":"string"},"child_categories":{"items":{"$ref":"#/components/schemas/ChildCategory"},"type":"array"},"depth":{"type":"integer"},"id":{"type":"string"},"pip_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"url_key":{"type":"string"}},"required":["category_type","child_categories","depth","id","pip_id","title","type","url_key"],"type":"object"},"CategoryError":{"properties":{"href":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"replied_at":{"type":"string"},"status":{"type":"integer"}},"required":["href","id","message","replied_at","status"],"type":"object"},"CategoryErrorResponse":{"properties":{"$schema":{"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/CategoryError"},"type":"array"}},"required":["$schema","errors"],"type":"object"},"CategorySummary":{"properties":{"category_type":{"type":"string"},"id":{"type":"string"},"key":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"}},"required":["category_type","id","key","title","type"],"type":"object"},"ChildCategory":{"properties":{"category_type":{"type":"string"},"child_categories":{"items":{"$ref":"#/components/schemas/ChildCategory"},"type":"array"},"depth":{"type":"integer"},"id":{"type":"string"},"pip_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"url_key":{"type":"string"}},"required":["category_type","child_categories","depth","id","pip_id","title","type","url_key"],"type":"object"},"ClipSummary":{"properties":{"ancestors":{"items":{"$ref":"#/components/schemas/AncestorSummary"},"type":"array"},"available_versions":{"items":{"$ref":"#/components/schemas/AvailableVersions"},"type":"array"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"media_type":{"type":"string"},"network_summary":{"$ref":"#/components/schemas/NetworkSummary"},"pid":{"type":"string"},"release_date":{"type":"string"},"short_synopsis":{"type":"string"},"titles":{"$ref":"#/components/schemas/ProgrammeTitles"},"type":{"enum":["clip_summary"],"type":"string"}},"required":["ancestors","available_versions","images","media_type","network_summary","pid","release_date","short_synopsis","titles","type"],"type":"object"},"Contact":{"properties":{"handle":{"type":"string"},"name":{"type":"string"},"service":{"type":"string"},"url":{"type":"string"}},"required":["handle","name","service","url"],"type":"object"},"DateRange":{"properties":{"end":{"type":"string"},"start":{"type":"string"}},"required":["end","start"],"type":"object"},"DisplayModule":{"properties":{"description":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"type":"string"}},"type":"object"},"Empty":{"type":"object","nullable":true},"EpisodeSummary":{"properties":{"ancestors":{"items":{"$ref":"#/components/schemas/AncestorSummary"},"type":"array"},"available_versions":{"items":{"$ref":"#/components/schemas/AvailableVersions"},"type":"array"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"media_type":{"type":"string"},"network_summary":{"$ref":"#/components/schemas/NetworkSummary"},"pid":{"type":"string"},"release_date":{"type":"string"},"short_synopsis":{"type":"string"},"titles":{"$ref":"#/components/schemas/ProgrammeTitles"},"type":{"enum":["episode_summary"],"type":"string"}},"required":["ancestors","available_versions","images","media_type","network_summary","pid","release_date","short_synopsis","titles","type"],"type":"object"},"Error":{"properties":{"href":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"replied_at":{"type":"string"}},"required":["href","id","message","replied_at"],"type":"object"},"ErrorResponse":{"properties":{"$schema":{"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"type":"array"}},"required":["$schema","errors"],"type":"object"},"ExperienceResponse":{"properties":{"$schema":{"type":"string"},"data":{"items":{"$ref":"#/components/schemas/DisplayModule"},"type":"array"}},"required":["$schema","data"],"type":"object"},"ExternalPartner":{"properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"],"type":"object"},"Image":{"properties":{"id":{"type":"string"},"image_type":{"type":"string"},"template_url":{"type":"string"},"type":{"type":"string"}},"required":["id","image_type","template_url","type"],"type":"object"},"MetaData":{"properties":{"miscellaneous":{"$ref":"#/components/schemas/Miscellaneous"},"origin":{"$ref":"#/components/schemas/Origin"},"programme_type":{"type":"string"},"type":{"type":"string"}},"required":["miscellaneous","origin","programme_type","type"],"type":"object"},"Miscellaneous":{"properties":{"title":{"type":"string"}},"required":["title"],"type":"object"},"MusicExportError":{"properties":{"message":{"type":"string"},"replied_at":{"type":"integer"},"status":{"type":"integer"}},"required":["message","replied_at","status"],"type":"object"},"MusicExportErrorResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/MusicExportError"},"type":"array"},"schema":{"type":"string"}},"required":["errors","schema"],"type":"object"},"MusicExportJob":{"properties":{"created_at":{"type":"string"},"id":{"type":"string"},"job_id":{"type":"string"},"status":{"type":"string"},"vendor":{"type":"string"}},"required":["created_at","id","job_id","status","vendor"],"type":"object"},"MusicExportPreferences":{"properties":{"access_expires_at":{"type":"string"},"access_token":{"type":"string"},"add_plus_export":{"type":"boolean"},"authorization_code":{"type":"string"},"last_export":{"type":"string"},"legacy_state":{"type":"string"},"partner_id":{"type":"string"},"refresh_token":{"type":"string"},"terms":{"type":"boolean"},"vendor":{"type":"string"}},"required":["access_expires_at","access_token","add_plus_export","authorization_code","last_export","legacy_state","partner_id","refresh_token","terms","vendor"],"type":"object"},"MusicExportPreferencesResponse":{"properties":{"method":{"type":"string"},"replied_at":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MusicExportPreferences"},"type":"array"},"schema":{"type":"string"},"total":{"type":"integer"}},"required":["method","replied_at","results","schema","total"],"type":"object"},"MusicExportSuccess":{"properties":{"method":{"type":"string"},"replied_at":{"type":"string"},"schema":{"type":"string"}},"required":["method","replied_at","schema"],"type":"object"},"MusicPopularityArtist":{"properties":{"gid":{"type":"string"},"id":{"type":"string"},"imagePid":{"type":"string"},"name":{"type":"string"},"score":{"type":"integer"},"sortName":{"type":"string"}},"required":["gid","id","imagePid","name","score","sortName"],"type":"object"},"MusicPopularityArtists":{"properties":{"limit":{"type":"integer"},"method":{"type":"string"},"offset":{"type":"integer"},"repliedAt":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MusicPopularityArtist"},"type":"array"},"schema":{"type":"string"},"total":{"type":"integer"}},"required":["method","repliedAt","results","schema","total"],"type":"object"},"MusicPopularityError":{"properties":{"errors":{"items":{"type":"string"},"type":"array"},"schema":{"type":"string"}},"type":"object"},"MusicPopularityPlaylist":{"properties":{"categories":{"items":{"type":"string"},"type":"array"},"commentsEnabled":{"type":"boolean"},"description":{"type":"string"},"externalPartners":{"items":{"$ref":"#/components/schemas/ExternalPartner"},"type":"array"},"genre":{"type":"string"},"id":{"type":"string"},"imagePid":{"type":"string"},"imageUrl":{"type":"string"},"kind":{"type":"string"},"mood":{"type":"string"},"oneOff":{"type":"boolean"},"playlistPlaybackType":{"type":"string"},"score":{"type":"integer"},"serviceId":{"type":"string"},"title":{"type":"string"},"updatedAt":{"type":"string"},"visibility":{"type":"string"},"wideImagePid":{"type":"string"},"wideImageUrl":{"type":"string"}},"required":["categories","commentsEnabled","description","externalPartners","genre","id","imagePid","imageUrl","kind","mood","oneOff","playlistPlaybackType","score","serviceId","title","updatedAt","visibility","wideImagePid","wideImageUrl"],"type":"object"},"MusicPopularityPlaylists":{"properties":{"limit":{"type":"integer"},"method":{"type":"string"},"offset":{"type":"integer"},"repliedAt":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MusicPopularityPlaylist"},"type":"array"},"schema":{"type":"string"},"total":{"type":"integer"}},"required":["method","repliedAt","results","schema","total"],"type":"object"},"MusicPopularityTrack":{"properties":{"album":{"type":"string"},"artistGid":{"type":"string"},"artistName":{"type":"string"},"artists":{"items":{"$ref":"#/components/schemas/MusicTrackArtist"},"type":"array"},"baseTitle":{"type":"string"},"classical":{"type":"boolean"},"id":{"type":"string"},"mergedIds":{"items":{"type":"string"},"type":"array"},"preferredMultiplayRecordAudio":{"$ref":"#/components/schemas/MusicRecordAudio"},"preferredRecordAudio":{"$ref":"#/components/schemas/MusicRecordAudio"},"radioEdit":{"type":"boolean"},"recordAudio":{"items":{"$ref":"#/components/schemas/MusicRecordAudio"},"type":"array"},"recordImageHref":{"type":"string"},"recordImagePid":{"type":"string"},"score":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"required":["id","score"],"type":"object"},"MusicPopularityTracks":{"properties":{"limit":{"type":"integer"},"method":{"type":"string"},"offset":{"type":"integer"},"repliedAt":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MusicPopularityTrack"},"type":"array"},"schema":{"type":"string"},"total":{"type":"integer"}},"required":["method","repliedAt","results","schema","total"],"type":"object"},"MusicRecordAudio":{"properties":{"audioType":{"type":"string"},"duration":{"type":"integer"},"identifier":{"type":"string"},"resourceType":{"type":"string"}},"required":["audioType","duration","identifier","resourceType"],"type":"object"},"MusicTrackArtist":{"properties":{"gid":{"type":"string"},"imagePid":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"sortName":{"type":"string"}},"required":["gid","imagePid","name","role","sortName"],"type":"object"},"Network":{"properties":{"active":{"type":"boolean"},"contacts":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"},"date_ranges":{"items":{"$ref":"#/components/schemas/DateRange"},"type":"array"},"group":{"type":"string"},"id":{"type":"string"},"international":{"type":"boolean"},"key":{"type":"string"},"preset":{"type":"boolean"},"promoted_category_summaries":{"items":{"$ref":"#/components/schemas/CategorySummary"},"type":"array"},"services":{"items":{"$ref":"#/components/schemas/Service"},"type":"array"},"short_title":{"type":"string"},"sort":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"required":["active","contacts","date_ranges","group","id","international","key","preset","services","short_title","sort","title","type"],"type":"object"},"NetworkSummary":{"properties":{"active":{"type":"boolean"},"group":{"type":"string"},"id":{"type":"string"},"key":{"type":"string"},"titles":{"$ref":"#/components/schemas/NetworkTitles"},"type":{"type":"string"}},"required":["active","group","id","key","titles","type"],"type":"object"},"NetworkTitles":{"properties":{"long_title":{"type":"string"},"short_title":{"type":"string"},"type":{"type":"string"}},"required":["long_title","short_title","type"],"type":"object"},"NetworksResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"integer"},"offset":{"type":"integer"},"results":{"items":{"$ref":"#/components/schemas/Network"},"type":"array"},"total":{"type":"integer"}},"required":["$schema","limit","offset","results","total"],"type":"object"},"Origin":{"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"PersonalisedCategories":{"properties":{"created":{"type":"string"},"type":{"type":"string"}},"required":["created","type"],"type":"object"},"PersonalisedCategoriesResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}},"required":["$schema","limit","offset","total"],"type":"object"},"PersonalisedMusicActivity":{"properties":{"action":{"type":"string"},"activity":{"type":"string"},"added_at":{"type":"string"},"data":{"items":{"$ref":"#/components/schemas/PersonalisedMusicData"},"type":"array"},"domain":{"type":"string"},"id":{"type":"string"},"meta_data":{"$ref":"#/components/schemas/PersonalisedMusicMetaData"},"type":{"type":"string"},"urn":{"type":"string"}},"required":["action","activity","added_at","data","domain","id","meta_data","type","urn"],"type":"object"},"PersonalisedMusicArtist":{"properties":{"id":{"type":"string"},"images":{"items":{"$ref":"#/components/schemas/PersonalisedMusicImage"},"type":"array"},"name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"PersonalisedMusicBatchRequest":{"properties":{"action":{"type":"string"},"added_at":{"type":"string"},"context":{"type":"string"},"domain":{"type":"string"},"id":{"type":"string"},"meta_data":{"$ref":"#/components/schemas/PersonalisedMusicMetaData"},"type":{"type":"string"}},"required":["action","domain","id","type"],"type":"object"},"PersonalisedMusicClip":{"properties":{"contributors":{"items":{"type":"string"},"type":"array"},"endDate":{"type":"string"},"entityType":{"type":"string"},"imageUrl":{"type":"string"},"masterbrandMid":{"type":"string"},"mediaType":{"type":"string"},"parentProgramme":{"$ref":"#/components/schemas/PersonalisedMusicClipParentProgramme"},"pid":{"type":"string"},"startDate":{"type":"string"},"synopsis":{"type":"string"},"title":{"type":"string"},"version":{"$ref":"#/components/schemas/PersonalisedMusicVersion"}},"type":"object"},"PersonalisedMusicClipParentProgramme":{"properties":{"entityType":{"type":"string"},"pid":{"type":"string"},"title":{"type":"string"}},"type":"object"},"PersonalisedMusicData":{"properties":{"artist":{"$ref":"#/components/schemas/PersonalisedMusicArtist"},"clip":{"$ref":"#/components/schemas/PersonalisedMusicClip"},"genre":{"$ref":"#/components/schemas/PersonalisedMusicGenre"},"playlist":{"$ref":"#/components/schemas/PersonalisedMusicPlaylist"},"service":{"$ref":"#/components/schemas/PersonalisedMusicService"},"track":{"$ref":"#/components/schemas/PersonalisedMusicTrack"}},"type":"object"},"PersonalisedMusicError":{"properties":{"message":{"type":"string"},"replied_at":{"type":"integer"},"status":{"type":"integer"}},"required":["message","replied_at","status"],"type":"object"},"PersonalisedMusicErrorResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/PersonalisedMusicError"},"type":"array"},"schema":{"type":"string"}},"required":["errors","schema"],"type":"object"},"PersonalisedMusicGenre":{"properties":{"id":{"type":"string"},"key":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"PersonalisedMusicImage":{"properties":{"format":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"}},"type":"object"},"PersonalisedMusicMetaData":{"properties":{"key":{"type":"string"}},"required":["key"],"type":"object"},"PersonalisedMusicPlaylist":{"properties":{"description":{"type":"string"},"images":{"items":{"$ref":"#/components/schemas/PersonalisedMusicImage"},"type":"array"},"playback_type":{"type":"string"},"service_id":{"type":"string"},"title":{"type":"string"},"tracks":{"$ref":"#/components/schemas/PersonalisedMusicTrack"},"type":{"type":"string"},"updated_at":{"type":"string"},"version":{"$ref":"#/components/schemas/PersonalisedMusicPlaylistVersion"}},"type":"object"},"PersonalisedMusicPlaylistVersion":{"properties":{"duration":{"type":"string"},"expires_at":{"type":"string"},"id":{"type":"string"},"starts_at":{"type":"string"},"warnings":{"items":{"type":"string"},"type":"array"}},"required":["warnings"],"type":"object"},"PersonalisedMusicRequest":{"properties":{"action":{"type":"string"},"added_at":{"type":"string"},"context":{"type":"string"},"meta_data":{"$ref":"#/components/schemas/PersonalisedMusicMetaData"}},"required":["action"],"type":"object"},"PersonalisedMusicResponse":{"properties":{"limit":{"type":"integer"},"method":{"type":"string"},"offset":{"type":"integer"},"replied_at":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PersonalisedMusicActivity"},"type":"array"},"schema":{"type":"string"},"total":{"type":"integer"}},"required":["limit","method","offset","replied_at","results","schema","total"],"type":"object"},"PersonalisedMusicService":{"properties":{"id":{"type":"string"},"key":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"PersonalisedMusicSuccess":{"properties":{"method":{"type":"string"},"replied_at":{"type":"string"},"schema":{"type":"string"}},"required":["method","replied_at","schema"],"type":"object"},"PersonalisedMusicTrack":{"properties":{"contributions":{"items":{"$ref":"#/components/schemas/PersonalisedMusicTrackContribution"},"type":"array"},"id":{"type":"string"},"images":{"items":{"$ref":"#/components/schemas/PersonalisedMusicTrackImage"},"type":"array"},"media":{"items":{"$ref":"#/components/schemas/PersonalisedMusicTrackMedia"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"version":{"$ref":"#/components/schemas/PersonalisedMusicVersion"}},"required":["contributions","id","images","media","title","type","version"],"type":"object"},"PersonalisedMusicTrackContribution":{"properties":{"id":{"type":"string"},"images":{"items":{"$ref":"#/components/schemas/PersonalisedMusicTrackImage"},"type":"array"},"name":{"type":"string"},"role":{"type":"string"}},"required":["id","images","name","role"],"type":"object"},"PersonalisedMusicTrackImage":{"properties":{"format":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"}},"required":["format","id","type"],"type":"object"},"PersonalisedMusicTrackMedia":{"properties":{"duration":{"type":"integer"},"format":{"type":"string"},"id":{"type":"string"},"scope":{"type":"string"},"source":{"type":"string"},"type":{"type":"string"}},"required":["duration","format","id","scope","source","type"],"type":"object"},"PersonalisedMusicVersion":{"properties":{"classical":{"type":"boolean"},"duration":{"type":"string"},"radio":{"type":"boolean"},"vpid":{"type":"string"}},"type":"object"},"PersonalisedNetworks":{"properties":{"created":{"type":"string"},"type":{"type":"string"}},"required":["created","type"],"type":"object"},"PersonalisedNetworksResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"integer"},"offset":{"type":"integer"},"results":{"items":{"$ref":"#/components/schemas/PersonalisedNetworks"},"type":"array"},"total":{"type":"integer"}},"required":["$schema","limit","offset","results","total"],"type":"object"},"PersonalisedRadioActivity":{"properties":{"action":{"type":"string"},"activity":{"type":"string"},"added_at":{"type":"string"},"data":{"$ref":"#/components/schemas/ProgrammeSummary"},"domain":{"type":"string"},"id":{"type":"string"},"metadata":{"$ref":"#/components/schemas/MetaData"},"type":{"type":"string"},"uas_type":{"type":"string"},"urn":{"type":"string"}},"required":["action","activity","added_at","data","domain","id","metadata","type","uas_type","urn"],"type":"object"},"PersonalisedRadioBatchRequest":{"properties":{"action":{"type":"string"},"added_at":{"type":"string"},"context":{"type":"string"},"id":{"type":"string"},"metadata":{"$ref":"#/components/schemas/PersonalisedRadioMetaData"},"type":{"type":"string"}},"required":["action"],"type":"object"},"PersonalisedRadioErrorResponse":{"properties":{"$schema":{"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/PersonalisedRadioErrorResponse_errors"},"type":"array"}},"required":["$schema","errors"],"type":"object"},"PersonalisedRadioErrorResponse_errors":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"href":{"type":"string"},"id":{"type":"string"},"status":{"type":"integer"},"timestamp":{"type":"integer"},"title":{"type":"string"}},"required":["code","detail","href","id","status","timestamp","title"]},"PersonalisedRadioMetaData":{"properties":{"key":{"type":"string"}},"required":["key"],"type":"object"},"PersonalisedRadioRequest":{"properties":{"action":{"type":"string"},"added_at":{"type":"string"},"context":{"type":"string"},"metadata":{"$ref":"#/components/schemas/PersonalisedRadioMetaData"}},"required":["action"],"type":"object"},"PersonalisedRadioResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"integer"},"method":{"type":"string"},"offset":{"type":"integer"},"replied_at":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PersonalisedRadioActivity"},"type":"array"},"total":{"type":"integer"}},"required":["$schema","limit","method","offset","replied_at","results","total"],"type":"object"},"PersonalisedRadioSuccessResponse":{"properties":{"$schema":{"type":"string"},"method":{"type":"string"},"replied_at":{"type":"string"}},"required":["$schema","method","replied_at"],"type":"object"},"PlayableItem":{"properties":{"description":{"type":"string"},"image_url":{"type":"string"},"pid":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"version_pid":{"type":"string"}},"type":"object"},"PlayspaceContainer":{"properties":{"id":{"type":"string"},"members":{"items":{"$ref":"#/components/schemas/PlayableItem"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"Podcast":{"properties":{"category_summaries":{"items":{"$ref":"#/components/schemas/CategorySummary"},"type":"array"},"days_available":{"type":"integer"},"entity_type":{"type":"string"},"first_published_date":{"type":"string"},"frequency":{"type":"string"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"latest_available_episodes":{"items":{"$ref":"#/components/schemas/PodcastEpisodeSummary"},"type":"array"},"network_summary":{"$ref":"#/components/schemas/NetworkSummary"},"pid":{"type":"string"},"rss_url":{"type":"string"},"synopses":{"$ref":"#/components/schemas/PodcastSynopses"},"territory":{"type":"string"},"titles":{"$ref":"#/components/schemas/ProgrammeTitles"},"total_available_episodes":{"type":"integer"},"type":{"type":"string"},"updated_at":{"type":"string"}},"required":["category_summaries","days_available","entity_type","first_published_date","frequency","images","latest_available_episodes","network_summary","pid","rss_url","synopses","territory","titles","total_available_episodes","type","updated_at"],"type":"object"},"PodcastEpisodeSummary":{"properties":{"asset_url":{"type":"string"},"available_versions":{"items":{"$ref":"#/components/schemas/AvailableVersions"},"type":"array"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"media_type":{"type":"string"},"network_summary":{"$ref":"#/components/schemas/NetworkSummary"},"pid":{"type":"string"},"release_date":{"type":"string"},"short_synopsis":{"type":"string"},"titles":{"$ref":"#/components/schemas/ProgrammeTitles"},"type":{"type":"string"}},"required":["asset_url","available_versions","images","media_type","network_summary","pid","release_date","short_synopsis","titles","type"],"type":"object"},"PodcastEpisodesResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"number"},"offset":{"type":"number"},"results":{"items":{"$ref":"#/components/schemas/PodcastEpisodeSummary"},"type":"array"},"total":{"type":"number"}},"required":["$schema","limit","offset","results","total"]},"PodcastError":{"properties":{"href":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"replied_at":{"type":"string"},"status":{"type":"number"}},"type":"object"},"PodcastErrorResponse":{"properties":{"$schema":{"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/PodcastError"},"type":"array"}},"type":"object"},"PodcastSynopses":{"properties":{"long":{"type":"string"},"medium":{"type":"string"},"short":{"type":"string"},"type":{"type":"string"}},"required":["long","medium","short","type"],"type":"object"},"PodcastsFeatured":{"properties":{"featured_podcasts":{"items":{"$ref":"#/components/schemas/Podcast"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"PodcastsFeaturedResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"number"},"offset":{"type":"number"},"results":{"items":{"$ref":"#/components/schemas/PodcastsFeatured"},"type":"array"},"total":{"type":"number"}},"required":["$schema","limit","offset","results","total"]},"PodcastsResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"integer"},"offset":{"type":"integer"},"results":{"items":{"$ref":"#/components/schemas/Podcast"},"type":"array"},"total":{"type":"integer"}},"required":["$schema","limit","offset","results","total"],"type":"object"},"PopularError":{"properties":{"href":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"replied_at":{"type":"string"},"status":{"type":"integer"}},"required":["href","id","message","replied_at","status"],"type":"object"},"PopularErrorResponse":{"properties":{"$schema":{"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/PopularError"},"type":"array"}},"required":["$schema","errors"],"type":"object"},"PopularItemSummary":{"properties":{"data":{"$ref":"#/components/schemas/ProgrammeSummary"},"id":{"type":"string"},"score":{"type":"integer"},"type":{"type":"string"}},"required":["data","id","score","type"],"type":"object"},"PopularResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"integer"},"offset":{"type":"integer"},"results":{"items":{"$ref":"#/components/schemas/PopularItemSummary"},"type":"array"},"total":{"type":"integer"}},"required":["$schema","limit","offset","results","total"],"type":"object"},"Programme":{"properties":{"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"latest_available_episodes":{"items":{"$ref":"#/components/schemas/EpisodeSummary"},"type":"array"},"network_summary":{"$ref":"#/components/schemas/NetworkSummary"},"pid":{"type":"string"},"short_synopsis":{"type":"string"},"titles":{"$ref":"#/components/schemas/ProgrammeTitles"},"total_available_episodes":{"type":"integer"},"type":{"enum":["brand_summary","series_summary","episode_summary","clip_summary"],"type":"string"}},"required":["images","network_summary","pid","short_synopsis","titles","type"],"type":"object"},"ProgrammeSummary":{"properties":{"pid":{"type":"string"},"type":{"enum":["brand_summary","series_summary","episode_summary","clip_summary"],"type":"string"}},"required":["pid","type"],"type":"object"},"ProgrammeTitles":{"properties":{"display_title":{"type":"string"},"entity_title":{"type":"string"},"primary_title":{"type":"string"},"secondary_title":{"type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ProgrammesResponse":{"properties":{"$schema":{"type":"string"},"limit":{"type":"integer"},"offset":{"type":"integer"},"results":{"items":{"$ref":"#/components/schemas/ProgrammeSummary"},"type":"array"},"total":{"type":"integer"}},"required":["$schema","limit","offset","results","total"],"type":"object"},"RadioError":{"properties":{"code":{"type":"string"},"detail":{"type":"string"},"href":{"type":"string"},"id":{"type":"string"},"status":{"type":"integer"},"timestamp":{"type":"integer"},"title":{"type":"string"}},"required":["code","detail","href","id","status","timestamp","title"],"type":"object"},"RadioErrorResponse":{"properties":{"$schema":{"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/RadioError"},"type":"array"}},"required":["$schema","errors"],"type":"object"},"SeriesSummary":{"properties":{"ancestors":{"items":{"$ref":"#/components/schemas/AncestorSummary"},"type":"array"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"latest_available_episodes":{"items":{"$ref":"#/components/schemas/EpisodeSummary"},"type":"array"},"network_summary":{"$ref":"#/components/schemas/NetworkSummary"},"pid":{"type":"string"},"short_synopsis":{"type":"string"},"titles":{"$ref":"#/components/schemas/ProgrammeTitles"},"total_available_episodes":{"type":"integer"},"type":{"enum":["series_summary"],"type":"string"}},"required":["ancestors","images","latest_available_episodes","network_summary","pid","short_synopsis","titles","total_available_episodes","type"],"type":"object"},"Service":{"properties":{"active":{"type":"boolean"},"coverage":{"type":"string"},"date_ranges":{"items":{"$ref":"#/components/schemas/DateRange"},"type":"array"},"default":{"type":"boolean"},"default_language":{"type":"string"},"id":{"type":"string"},"region":{"type":"string"},"short_title":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"}},"required":["active","coverage","date_ranges","default","default_language","id","region","short_title","title","type"],"type":"object"}}}} |