openapi-directory/api/bbc.co.uk.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"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"