The following documentation is automatically generated. Please do not edit this file, but rather the original, inline with Net::Async::Spotify::API::Generated::Shows at lib/Net/Async/Spotify/API/Generated/Shows.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::Shows - Package representing Spotify Shows 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_a_show
get_a_show - Get a Show
Get Spotify catalog information for a single show 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 show.
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:
- show object
On success, the HTTP status code in the response header is 200 OK and the response body contains a show object in JSON format. On error, the header status code is an error code and the response body contains an error object. If a show is unavailable in the given market the HTTP status code in the response header is 404 NOT FOUND.Try in our Web Console
get_a_shows_episodes
get_a_shows_episodes - Get a Show's Episodes
Get Spotify catalog information about an show’s episodes. Optional parameters can be used to limit the number of episodes returned.
with Request details being:
header
- Authorization
-
Type: string | Required: required 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 show.
query_parameter
- limit
-
Type: integer | Required: optional The maximum number of episodes to return. Default: 20. Minimum: 1. Maximum: 50.
- 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.
- offset
-
Type: integer | Required: optional The index of the first episode to return. Default: 0 (the first object). Use with limit to get the next set of episodes.
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 array of simplified episode objects (wrapped in a paging object) in JSON format. On error, the header status code is an error code and the response body contains an error object. If a show is unavailable in the given market the HTTP status code in the response header is 404 NOT FOUND. Unavailable episodes are filtered out.Try in our Web Console
get_multiple_shows
get_multiple_shows - Get Multiple Shows
Get Spotify catalog information for several shows 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 shows. 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 shows and whose value is an array of simple show object 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. If a show is unavailable in the given market, a null value is returned. Duplicate ids in the query will result in duplicate objects in the response. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console