The following documentation is automatically generated. Please do not edit this file, but rather the original, inline with Net::Async::Spotify::API::Generated::Episodes at lib/Net/Async/Spotify/API/Generated/Episodes.pm (on the system that originally ran this). If you do edit this file, and don't want your changes to be removed, make sure you change the first line.
NAME
Net::Async::Spotify::API::Generated::Episodes - Package representing Spotify Episodes API
DESCRIPTION
Autogenerated module. Based on https://developer.spotify.com/documentation/web-api/reference/#reference-index Check crawl-api-doc.pl for more information.
METHODS
get_an_episode
get_an_episode - Get an Episode
Get Spotify catalog information for a single episode identified by its unique Spotify ID.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details.
path_parameter
- id
-
Type: string | Required: required The Spotify ID for the episode.
query_parameter
- market
-
Type: string | Required: optional An ISO 3166-1 alpha-2 country code. If a country code is specified, only shows and episodes that are available in that market will be returned. If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter. Note: If neither market or user country are provided, the content is considered unavailable for the client. Users can view the country that is associated with their account in the account settings.
and Response Objects being:
- episode object
On success, the HTTP status code in the response header is 200 OK and the response body contains an episode object in JSON format. On error, the header status code is an error code and the response body contains an error object. If an episode is unavailable in the given market the HTTP status code in the response header is 404 NOT FOUND.Try in our Web Console
get_multiple_episodes
get_multiple_episodes - Get Multiple Episodes
Get Spotify catalog information for several episodes based on their Spotify IDs.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details.
query_parameter
- ids
-
Type: string | Required: required A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.
- market
-
Type: string | Required: optional An ISO 3166-1 alpha-2 country code. If a country code is specified, only shows and episodes that are available in that market will be returned. If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter. Note: If neither market or user country are provided, the content is considered unavailable for the client. Users can view the country that is associated with their account in the account settings.
and Response Objects being:
- an object - an object
On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is episodes and whose value is an array of episode objects in JSON format.Objects are returned in the order requested. If an object is not found, a null value is returned in the appropriate position. Duplicate ids in the query will result in duplicate objects in the response. If an episode is unavailable in the given market, a null value is returned. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console