Podcast on OpenSubsonic

createPodcastChannel

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/createPodcastChannel Since 1.9.0

Adds a new Podcast channel. Note: The user must be authorized for Podcast administration (see Settings > Users > User is allowed to administrate Podcasts).

Parameters

Parameter	Req.	OpenS.	Default	Comment
`url`	Yes			The URL of the Podcast to add.

Example

http://your-server/rest/createPodcastChannel.view?url=url&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1"
 }
}

deletePodcastChannel

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/deletePodcastChannel Since 1.9.0

Deletes a Podcast channel. Note: The user must be authorized for Podcast administration (see Settings > Users > User is allowed to administrate Podcasts).

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The ID of the Podcast channel to delete.

Example

http://your-server/rest/deletePodcastChannel.view?id=123&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true
 }
}

{
 "subsonic-response": {
 "status":"ok",
 "version":"1.16.1",
 }
}

deletePodcastEpisode

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/deletePodcastEpisode Since 1.9.0

Deletes a Podcast episode. Note: The user must be authorized for Podcast administration (see Settings > Users > User is allowed to administrate Podcasts).

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The ID of the Podcast episode to delete.

Example

http://your-server/rest/deletePodcastEpisode.view?id=123&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1"
 }
}

downloadPodcastEpisode

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/downloadPodcastEpisode Since 1.9.0

Request the server to start downloading a given Podcast episode. Note: The user must be authorized for Podcast administration (see Settings > Users > User is allowed to administrate Podcasts).

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The ID of the Podcast episode to download.

Example

http://your-server/rest/downloadPodcastEpisode.view?id=123&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1"
 }
}

getNewestPodcasts

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getNewestPodcasts Since 1.13.0

Returns the most recently published Podcast episodes.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`count`	No		20	The maximum number of episodes to return.

Example

http://your-server/rest/getNewestPodcasts.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested newestPodcasts element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "newestPodcasts": {
 "episode": [
 {
 "id": "7390",
 "parent": "7389",
 "isDir": "false",
 "title": "Jonas Gahr Støre",
 "album": "NRK – Hallo P3",
 "artist": "Podcast",
 "year": "2015",
 "coverArt": "7389",
 "size": "41808585",
 "contentType": "audio/mpeg",
 "suffix": "mp3",
 "duration": "2619",
 "bitRate": "128",
 "isVideo": "false",
 "created": "2015-09-07T20:07:31.000Z",
 "artistId": "453",
 "type": "podcast",
 "streamId": "7410",
 "channelId": "17",
 "description": "Jonas Gahr Støre fra Arbeiderpartiet er med i dagens partilederutspørring i Hallo P3!",
 "status": "completed",
 "publishDate": "2015-09-07T15:29:00.000Z"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "newestPodcasts": {
 "episode": [
 {
 "id": "7390",
 "parent": "7389",
 "isDir": "false",
 "title": "Jonas Gahr Støre",
 "album": "NRK – Hallo P3",
 "artist": "Podcast",
 "year": "2015",
 "coverArt": "7389",
 "size": "41808585",
 "contentType": "audio/mpeg",
 "suffix": "mp3",
 "duration": "2619",
 "bitRate": "128",
 "isVideo": "false",
 "created": "2015-09-07T20:07:31.000Z",
 "artistId": "453",
 "type": "podcast",
 "streamId": "7410",
 "channelId": "17",
 "description": "Jonas Gahr Støre fra Arbeiderpartiet er med i dagens partilederutspørring i Hallo P3!",
 "status": "completed",
 "publishDate": "2015-09-07T15:29:00.000Z"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`newestPodcasts`	`NewestPodcasts`	Yes		The podcasts

getPodcasts

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getPodcasts Since 1.6.0

Returns all Podcast channels the server subscribes to, and (optionally) their episodes. This method can also be used to return details for only one channel - refer to the id parameter. A typical use case for this method would be to first retrieve all channels without episodes, and then retrieve all episodes for the single channel the user selects.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`includeEpisodes`	No		true	(Since 1.9.0) Whether to include Podcast episodes in the returned result.
`id`	No			(Since 1.9.0) If specified, only return the Podcast channel with this ID.

Example

http://your-server/rest/getPodcasts.view?title=tata&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested podcasts element on success.

refreshPodcasts

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/refreshPodcasts Since 1.9.0

Requests the server to check for new Podcast episodes. Note: The user must be authorized for Podcast administration (see Settings > Users > User is allowed to administrate Podcasts).

Parameters

Takes no extra parameters.

Example

http://your-server/rest/refreshPodcasts.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1"
 }
}