Chapter 7. Station Service

Table of Contents

Services

Category radio station(s) by ID
Artist "Fan" radio station(s) by artist ID
User's radio station(s) by user ID
Radio stations for a published list/chart
Category video station(s) by ID
Video stations for a published list/chart

Responses

Station List Response (application/xml - ym:Stations)

main
shortdesc
longdesc
artists
moods
videos

Services

Category radio station(s) by ID

/radio/category/{ids}?appid=...&ratings=...&response=...&format=...&callback=...

GET

Returns radio stations for the specified categories.

Example: http://us.music.yahooapis.com/station/v1/radio/category/7318639?appid=[yourapplicationidhere]

Responses: “Station List Response (application/xml - ym:Stations)”

Required Parameters

Parameter	Value	Description
ids	string	Comma-separated list of release IDs.
appid	string	YDN Application ID. See Application IDs for more information.

Optional Parameters

Parameter	Value	Default / Possible values	Description
ratings	long		Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response	string	main	Comma-separated list of station response chunks to return. Default is main. See “Station List Response (application/xml - ym:Stations)” for possible values.
callback	string		If output is `json`, wraps the result in the specified callback function.
format	string	xml (default) json	Format of the result.

Artist "Fan" radio station(s) by artist ID

/radio/artist/{ids}?appid=...&ratings=...&response=...&format=...&callback=...

GET

Returns "fan" radio stations for the specified artists.

Example: http://us.music.yahooapis.com/station/v1/radio/artist/256352?appid=[yourapplicationidhere]

Responses: “Station List Response (application/xml - ym:Stations)”

Required Parameters

Parameter	Value	Description
ids	string	Comma-separated list of release IDs.
appid	string	YDN Application ID. See Application IDs for more information.

Optional Parameters

Parameter	Value	Default / Possible values	Description
ratings	long		Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response	string	main	Comma-separated list of station response chunks to return. Default is main. See “Station List Response (application/xml - ym:Stations)” for possible values.
callback	string		If output is json, wraps the result in the specified callback function.
format	string	xml (default) json	Format of the result.

User's radio station(s) by user ID

/radio/user/{ids}?appid=...&ratings=...&response=...&format=...&callback=...

GET

Returns radio stations for the specified users.

Example: http://us.music.yahooapis.com/station/v1/radio/user/1905196?appid=[yourapplicationidhere]

Responses: “Station List Response (application/xml - ym:Stations)”

Required Parameters

Parameter	Value	Description
ids	string	Comma-separated list of release IDs.
appid	string	YDN Application ID. See Application IDs for more information.

Optional Parameters

Parameter	Value	Default / Possible values	Description
ratings	long		Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response	string	main	Comma-separated list of station response chunks to return. Default is main. See “Station List Response (application/xml - ym:Stations)” for possible values.
callback	string		If output is json, wraps the result in the specified callback function.
format	string	xml (default) json	Format of the result.

Radio stations for a published list/chart

/radio/list/published/{id}?appid=...&start=...&count=...&intersectWith=...&flagWith=...&ratings=...&response=...&format=...&callback=...

GET

Returns radio stations in a published list.

Example: http://us.music.yahooapis.com/station/v1/radio/list/published/43643359?appid=[yourapplicationidhere]

Responses: “Station List Response (application/xml - ym:Stations)”

Required Parameters

Parameter	Value	Description
id	string	Published radio station list ID.
appid	string	YDN Application ID. See Application IDs for more information.

Optional Parameters

Parameter	Value	Default / Possible values	Description
start	nonNegativeInteger	1	Start index in the list.
count	nonNegativeInteger	25	Max 100. Number of items to return from start.
intersectWith	string	Examples: %2Flist%2FrecentlyPlayed%2F4596611 %2Flist%2Fpublished%2Fpopular%3Bcount=20 %2Flist%2Fsearch%2Fall%2Fmadonna	A URL-encoded list URI to intersect results with, starting with "/list/". This is the relative URI path of the list.
flagWith	string		A list URI to flag results with (same format as intersectWith). If an item also exists in the flagWith list, that item will contain a <FlaggedWith id=[listURI] /> element in the result.
ratings	long		Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response	string	main	Comma-separated list of station response chunks to return. Default is main. See “Station List Response (application/xml - ym:Stations)” for possible values.
format	string	xml (default) json	Format of the result.
callback	string		If output is json, wraps the result in the specified callback function.

Category video station(s) by ID

/video/category/{ids}?appid=...&ratings=...&response=...&format=...&callback=...

GET

Returns video stations for the specified categories.

Example: http://us.music.yahooapis.com/station/v1/video/category/7318639?appid=[yourapplicationidhere]

Responses: “Station List Response (application/xml - ym:Stations)”

Required Parameters

Parameter	Value	Default / Possible values	Description
ids	string		Comma-separated list of category IDs.
appid	string		YDN Application ID. See Application IDs for more information.

Optional Parameters

Parameter	Value	Default / Possible values	Description
ratings	long		Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response	string	main	Comma-separated list of station response chunks to return. Default is main. See “Station List Response (application/xml - ym:Stations)” for possible values.
callback	string		If output is json, wraps the result in the specified callback function.
format	string	xml (default) json	Format of the result.

Video stations for a published list/chart

/video/list/published/{id}?appid=...&start=...&count=...&intersectWith=...&flagWith=...&ratings=...&response=...&format=...&callback=...

GET

Returns video stations in a published list.

Example: http://us.music.yahooapis.com/station/v1/video/list/published/43643359?appid=[yourapplicationidhere]

Responses: “Station List Response (application/xml - ym:Stations)”

Required Parameters

Parameter	Value	Description
id	int	Published video station list ID.
appid	string	YDN Application ID. See Application IDs for more information.

Optional Parameters

Parameter	Value	Default / Possible values	Description
start	nonNegativeInteger	1	Start index in the list.
count	nonNegativeInteger	25	Max 100. Number of items to return from start.
intersectWith	string	Examples: %2Flist%2Fpublished%2F12345 %2Flist%2Fpublished%2F2839203%3Bcount=20	A URL-encoded list URI to intersect results with, starting with "/list/". This is the relative URI path of the list.
flagWith	string		A list URI to flag results with (same format as intersectWith). If an item also exists in the flagWith list, that item will contain a <FlaggedWith id=[listURI] /> element in the result.
ratings	long		Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response	string	main	Comma-separated list of station response chunks to return. Default is main. See “Station List Response (application/xml - ym:Stations)” for possible values.
format	string	xml (default) json	Format of the result.
callback	string		If output is json, wraps the result in the specified callback function.

Yahoo! Music API Guide