rocketbeans/rbtv-apidoc

API Dokumentation

Rocket Beans TV API v1.0.0

This is the official documentation for the rocketbeans.tv-API.

Base URL

Prepend this URL to each endpoint:

https://api.rocketbeans.tv/v1

Table of contents

• Blog

  • Get all Blog Posts
  • Get all Blog Posts (Preview)
  • Get Single Blog Post
  • Get Single Blog Post (Preview)

• Bohne

  • Get all Bohnen Portraits
  • Get Single Bohne
  • Get Single Bohne Portrait

• CMS

  • Get All Routes
  • Get Single CMS Page

• Frontend

  • Frontend Initialization Information

• Mediathek Episode

  • Get Episodes of Bohne
  • Get Single Episode
  • Get all Episodes of Season
  • Get all Episodes By Show
  • Get the last published Episodes (Preview)
  • Get single random episode ID
  • Get Abobox Content for self
  • Get all unsorted (no season set) Episodes By Show
  • Get Episodes of Bohne (Preview)
  • Get Single Episode (Preview)
  • Get all Episodes of Season (Preview)
  • Get all Episodes By Show (Preview)
  • Get all unsorted Episodes By Show (Preview)

• Mediathek Show

  • Get all Shows
  • Get Single Show
  • Get all featured Shows (Preview)
  • Get all Shows (Preview)
  • Get Single Show (Preview)
  • Get all Shows (PreviewMini)

• Playlist

  • Add playlist items to playlist
  • Add playlist items to playlist by playlist type
  • Create new playlist
  • Delete playlist by id
  • Get all playlists
  • Get playlist by playlist ID at certain playlist index
  • Get playlist by playlist type
  • Get playlist by UUID
  • Get playlist items by playlist id
  • Move playlist items on playlist
  • Remove all playlist items from playlist by id
  • Remove playlist items from playlist by id
  • Update playlist by id

• RBSCVideo

  • Exchange RBSC video token for signed URL token

• RBTVEvent

  • Get the current active RBTV Event
  • Get RBTV Event Team Information
  • Get joined RBTV Event Team
  • Join a RBTV Event Team

• Schedule

  • Get by-day schedule
  • Get by-day publish schedule
  • Get by-day page-ready schedule

• ScheduleLegacy

  • Get current running show
  • Get current week schedule
  • Get current week schedule grouped by day
  • Get the next n scheduled shows

• Shop

  • Get All Products

• StreamCount

  • Get Current Viewer Count

• Tag

  • Add tag to existing media episode
  • Create new tag with name and optionally pin it to media episode
  • Delete tag
  • Get all tags
  • Get tags by partial name / media episode
  • Hide tag on existing media episode
  • Pin tag to existing media item
  • Remove tag from existing media episode
  • Unhide tag on existing media episode
  • Unpin tag from existing media episode
  • Update tag
  • Vote for tag

• User

  • Request own User Information

Blog

Get all Blog Posts

Returns all blog posts for the given pagination parameters

GET /blog/all

Parameters

Name	Type	Default	Description
offset	number		(optional) Offset from the start
limit	number	4	(optional) Limits the number of returned blog posts. Maximum is 50.

Returns

Interface: blogResponse

Get all Blog Posts (Preview)

Returns all blog posts for the given pagination parameters

GET /blog/preview/all

Parameters

Name	Type	Default	Description
offset	number		(optional) Offset from the start
limit	number	4	(optional) Limits the number of returned blog posts. Maximum is 50.

Returns

Interface: blogPreviewResponse

Get Single Blog Post

GET /blog/:id

Parameters

Name	Type	Default	Description
id	number		The blog post ID

Returns

Interface: blogResponse

Get Single Blog Post (Preview)

GET /blog/preview/:id

Parameters

Name	Type	Default	Description
id	number		The blog post ID

Returns

Interface: blogPreviewResponse

Back to top

---

Bohne

Get all Bohnen Portraits

Returns reduced information about all team members.

GET /bohne/portrait/all

Returns

Interface: bohnePortrait

Get Single Bohne

Returns information about a single team member.

GET /bohne/:mgmtid

Parameters

Name	Type	Default	Description
mgmtid	number		The RocketMGMT ID for this bohne

Returns

Interface: bohneResponse

Get Single Bohne Portrait

Returns reduced information about a given team member.

GET /bohne/portrait/:mgmtid

Parameters

Name	Type	Default	Description
mgmtid	number		The RocketMGMT ID for this bohne

Returns

Interface: bohnePortrait

Back to top

---

CMS

Get All Routes

Returns all CMS routes (frontend paths which are connected to CMS pages)

GET /cms/route/all

Returns

Interface: cmsRouteResponse

Get Single CMS Page

Returns the given CMS page

GET /cms/:id

Parameters

Name	Type	Default	Description
id	string		The Page ID

Returns

Interface: cmsPageResponse

Back to top

---

Frontend

Frontend Initialization Information

Returns necessary information for frontend initialization, such as current stream details, cms routes etc.

GET /frontend/init

Returns

Interface: frontendInitResponse

Back to top

---

Mediathek Episode

Get Episodes of Bohne

Returns information about all episodes for the given Bohne.

GET /media/episode/bybohne/:id

Parameters

Name	Type	Default	Description
id	number		RocketMGMT ID of the Bohne
offset	number		(optional) Offset from the start
limit	number	10	(optional) Number of items to return. Maximum is 50.
order	string	ASC	(optional) Sort Order; ASC -> Oldest item First; DESC -> Newest item First

Returns

Interface: mediaEpisodeCombinedResponse

Get Single Episode

Returns information about a single episode.

GET /media/episode/:id

Parameters

Name	Type	Default	Description
id	number		Episode ID

Returns

Interface: mediaEpisodeCombinedResponse

Get all Episodes of Season

Returns information about all episodes of a given season.

GET /media/episode/byseason/:id

Parameters

Name	Type	Default	Description
id	number		Season ID
offset	number		(optional) Offset from the start
limit	number	10	(optional) Number of items to return. Maximum is 50.
order	string	ASC	(optional) Sort Order; ASC -> Oldest item First; DESC -> Newest item First

Returns

Interface: mediaEpisodeCombinedResponse

Get all Episodes By Show

Returns information about all episodes for the given show.

GET /media/episode/byshow/:id

Parameters

Name	Type	Default	Description
id	number		Show ID
offset	number		(optional) Offset from the start
limit	number	10	(optional) Number of items to return. Maximum is 50.
order	string	ASC	(optional) Sort Order; ASC -> Oldest item First; DESC -> Newest item First

Returns

Interface: mediaEpisodeCombinedResponse

Get the last published Episodes (Preview)

GET /media/episode/preview/newest

Parameters

Name	Type	Default	Description
offset	number		(optional) Offset from the start
limit	number	8	(optional) Number of items to return. Maximum is 50.
order	string	ASC	(optional) Sort Order; ASC -> Oldest item First; DESC -> Newest item First

Returns

Interface: mediaEpisodePreviewCombinedResponse

Get single random episode ID

Returns random episode ID of all available media episodes

GET /random

Returns

Interface: mediaEpisodeRandomVideoResponse

Get Abobox Content for self

Returns all episodes from subscribed shows and bohnen for the authorised user.

GET /media/abobox/self

Parameters

Name	Type	Default	Description
offset	number		(optional) Offset from the start
limit	number	8	(optional) Number of items to return. Maximum is 50.

Returns

Interface: mediaEpisodePreviewCombinedResponse

Get all unsorted (no season set) Episodes By Show

Returns information about all unsorted (no season set) episodes for the given show.

GET /media/episode/byshow/unsorted/:id

Parameters

Name	Type	Default	Description
id	number		Show ID
offset	number		(optional) Offset from the start
limit	number	10	(optional) Number of items to return. Maximum is 50.
order	string	ASC	(optional) Sort Order; ASC -> Oldest item First; DESC -> Newest item First

Returns

Interface: mediaEpisodePreviewCombinedResponse

Get Episodes of Bohne (Preview)

Returns reduced information about all episodes for the given Bohne.

GET /media/episode/bybohne/preview/:id

Parameters

Name	Type	Default	Description
id	number		RocketMGMT ID of the Bohne
order	string	ASC	(optional) Sort Order; ASC -> Oldest item First; DESC -> Newest item First

Returns

Interface: mediaEpisodePreviewCombinedResponse

Get Single Episode (Preview)

Returns reduced information about a single episode.

GET /media/episode/preview/:id

Parameters

Name	Type	Default	Description
id	number		Episode ID

Returns

Interface: mediaEpisodePreviewCombinedResponse

Get all Episodes of Season (Preview)

Returns reduced information about all episodes of a given season.

GET /media/episode/byseason/preview/:id

Parameters

Name	Type	Default	Description
id	number		Season ID
offset	number		(optional) Offset from the start
limit	number	10	(optional) Number of items to return. Maximum is 50.
order	string	ASC	(optional) Sort Order; ASC -> Oldest item First; DESC -> Newest item First

Returns

Interface: mediaEpisodePreviewCombinedResponse

Get all Episodes By Show (Preview)

Returns reduced information about all episodes for the given show.

GET /media/episode/byshow/preview/:id

Parameters

Name	Type	Default	Description
id	number		Show ID
offset	number		(optional) Offset from the start
limit	number	10	(optional) Number of items to return. Maximum is 50.
order	string	ASC	(optional) Sort Order; ASC -> Oldest item First; DESC -> Newest item First

Returns

Interface: mediaEpisodePreviewCombinedResponse

Get all unsorted Episodes By Show (Preview)

Returns reduced information about all unsorted (no season set) episodes for the given show.

GET /media/episode/byshow/unsorted/preview/:id

Parameters

Name	Type	Default	Description
id	number		Show ID
offset	number		(optional) Offset from the start
limit	number	10	(optional) Number of items to return. Maximum is 50.
order	string	ASC	(optional) Sort Order; ASC -> Oldest item First; DESC -> Newest item First

Returns

Interface: mediaEpisodePreviewCombinedResponse

Back to top

---

Mediathek Show

Get all Shows

GET /media/show/all

Parameters

Name	Type	Default	Description
offset	number		(optional) Offset from the start
limit	number	8	(optional) Number of items to return. Maximum is 50.
sortby	string	LastEpisode	(optional) possible values: LastEpisode
only	string		(optional) possible values: podcast

Returns

Interface: mediaShowResponse

Get Single Show

Returns information about the given show.

GET /media/show/:id

Parameters

Name	Type	Default	Description
id	number		Show ID

Returns

Interface: mediaShowResponse

Get all featured Shows (Preview)

GET /media/show/preview/featured

Parameters

Name	Type	Default	Description

Returns

Interface: mediaShowPreviewResponse

Get all Shows (Preview)

Returns paginated, reduced information about all shows.

GET /media/show/preview/all

Parameters

Name	Type	Default	Description
offset	number		(optional) Offset from the start
limit	number	8	(optional) Number of items to return. Maximum is 50.
sortby	string	LastEpisode	(optional) possible values: LastEpisode
only	string		(optional) Filters by attribute. Possible values: podcast

Returns

Interface: mediaShowPreviewResponse

Get Single Show (Preview)

Returns reduced information about the given show.

GET /media/show/preview/:id

Parameters

Name	Type	Default	Description
id	number		Show ID

Returns

Interface: mediaShowPreviewResponse

Get all Shows (PreviewMini)

Returns minimal information about all shows.

GET /media/show/preview/mini/all

Parameters

Name	Type	Default	Description
sortby	string	LastEpisode	(optional) possible values: LastEpisode
only	string		(optional) Filters by attribute. Possible values: podcast

Returns

Interface: mediaShowPreviewMiniResponse

Back to top

---

Playlist

Add playlist items to playlist

Add playlist items to playlist

POST /playlist/:id/addPlaylistItems

Returns

Interface: PlaylistItem

Add playlist items to playlist by playlist type

Add playlist items to playlist by playlist type

POST /playlist/addToSystemPlaylist/:playlistType

Returns

Interface: PlaylistItem

Create new playlist

Create new playlist

POST /playlist

Returns

Interface: Playlist

Delete playlist by id

Delete playlist by id

DELETE /playlist/:id

Get all playlists

Returns all playlists

GET /playlist/all

Returns

Interface: Playlist

Get playlist by playlist ID at certain playlist index

Returns playlist by playlist ID at certain playlist index

GET /playlist/:uuid/at/:playlistItemId

Returns

Interface: CombinedPlaylistResponse

Get playlist by playlist type

Returns playlist by playlist type

GET /playlist/byType/:playlistType

Returns

Interface: CombinedPlaylistResponse

Get playlist by UUID

Returns playlist by UUID

GET /playlist/:uuid

Returns

Interface: CombinedPlaylistResponse

Get playlist items by playlist id

Returns playlist items by playlist id

GET /playlist/:uuid/items

Returns

Interface: PlaylistItem

Move playlist items on playlist

Move playlist items on playlist

POST /playlist/:id/movePlaylistItems

Returns

Interface: CombinedPlaylistResponse

Remove all playlist items from playlist by id

Remove all playlist items from playlist by id

POST /playlist/:id/removePlaylistItems/all

Returns

Interface: CombinedPlaylistResponse

Remove playlist items from playlist by id

Remove playlist items from playlist by id

POST /playlist/:id/removePlaylistItems

Returns

Interface: CombinedPlaylistResponse

Update playlist by id

Update playlist by id

PUT /playlist/:id

Returns

Interface: CombinedPlaylistResponse

Back to top

---

RBSCVideo

Exchange RBSC video token for signed URL token

Returns sigend url to watch video token

GET /rbsc/video/token/:videoId

Parameters

Name	Type	Default	Description
videoId	string		(optional) RBSC Video ID

Returns

Interface: RBSCVideoToken

Back to top

---

RBTVEvent

Get the current active RBTV Event

Returns Information about the current active RBTV Event

GET /rbtvevent/active

Returns

Interface: IRBTVEvent

Get RBTV Event Team Information

Returns RBTV Event Team Information, restricted to active Events.

GET /rbtvevent/team/:id

Returns

Interface: IRBTVEventTeam

Get joined RBTV Event Team

Gets the joined Team for the given RBTV Event (which must be active in order to request these information)

GET /rbtvevent/:slug/team

Required OAuth Scopes: user.rbtvevent.read

Returns

Interface: IRBTVEventTeam

Join a RBTV Event Team

Joins the given Team for the given Event (the event must be active)

POST /rbtvevent/:slug/team/:id/join

Required OAuth Scopes: user.rbtvevent.manage

Returns

Interface: IRBTVEventTeam

Back to top

---

Schedule

Get by-day schedule

Returns the channel schedules für given time range

GET /schedule

Parameters

Name	Type	Default	Description
startDay	number		Unix Timestamp
endDay	number		Unix Timestamp
filterChannels	string[]		list of channelIds to filter for

Returns

Interface: ChannelGroupSchedule

Get by-day publish schedule

Returns the publish schedule.

GET /schedule/publish

Parameters

Name	Type	Default	Description
from	number		Unix Timestamp - Start Time (will be normalized to day)

Returns

Interface: UploadSchedule

Get by-day page-ready schedule

Returns the program schedule. Each day starts with the first schedule item of type 'live' or 'premiere'. Most of the time this will be "MoinMoin" at 10:30 CEST, except on weekends or when there are 'live'/'premiere' items at 0:00 CEST.

GET /schedule/normalized

Parameters

Name	Type	Default	Description
startDay	number		Unix Timestamp - Start Tim
endDay	number	startDay+(7*86400)	(optional) Unix timestamp - End Date

Returns

Interface: schedule

Back to top

---

ScheduleLegacy

Get current running show

Returns the current running/scheduled show
Drop-in replacement for http://api.rocketmgmt.de/[1.1/]schedule/current

GET /schedule/legacy/current

Returns

Interface: ILegacyMGMTScheduleItem

Get current week schedule

Returns the schedule of the current week, not grouped as Array
Drop-in replacement for http://api.rocketmgmt.de/[1.1/]schedule

GET /schedule/legacy

Returns

Interface: LegacyMGMTScheduleListResponse

Get current week schedule grouped by day

Returns the schedule of the current week, grouped by day
Drop-in replacement for http://api.rocketmgmt.de/[1.1/]schedule/weekdays

GET /schedule/legacy/weekdays

Returns

Interface: LegacyMGMTScheduleByDayResponse

Get the next n scheduled shows

Returns the next n scheduled shows, not grouped as Array
Drop-in replacement for http://api.rocketmgmt.de/[1.1/]schedule/next/:items

GET /schedule/legacy/next/:items

Returns

Interface: LegacyMGMTScheduleListResponse

Back to top

---

Shop

Get All Products

Returns information about all shop products.

GET /simpleshop/product/all

Parameters

Name	Type	Default	Description
offset	number		(optional) Offset from the start
limit	number	8	(optional) Number of items to return. Maximum is 50.

Returns

Interface: simpleShopItem

Back to top

---

StreamCount

Get Current Viewer Count

Returns information about the current viewers. Contains seperate numbers for Youtube, Twitch, and combined.

GET /streamcount

Returns

Interface: streamCount

Back to top

---

Tag

Add tag to existing media episode

Add tag to existing media episode

POST /tags/add/:tagId

Returns

Interface: AddTagResponse

Create new tag with name and optionally pin it to media episode

Create new tag

POST /tags

Returns

Interface: CreateTagResponse

Delete tag

Deletes tag with given tag id

DELETE /tags/:tagId

Returns

Interface: DeleteTagResponse

Get all tags

Returns all tags

GET /tags/all

Returns

Interface: GetAllTagsResponse

Get tags by partial name / media episode

Searches for tag names starting with name parameter OR tags linked to media episode id parameter

GET /tags

Returns

Interface: GetTagsResponse

Hide tag on existing media episode

Hide tag on media episode

POST /tags/hide/:tagId

Returns

Interface: HideTagResponse

Pin tag to existing media item

Pins tag to existing media episode

POST /tags/pin/:tagId

Returns

Interface: PinTagResponse

Remove tag from existing media episode

Remove tag fromn media episode

POST /tags/remove/:tagId

Returns

Interface: RemoveTagResponse

Unhide tag on existing media episode

Un-hide tag on media item

POST /tags/unhide/:tagId

Returns

Interface: UnhideTagResponse

Unpin tag from existing media episode

Unpins tag from existing media episode

POST /tags/unpin/:tagId

Returns

Interface: UnpinTagResponse

Update tag

Update tag details

PUT /tags/:tagId

Returns

Interface: UpdateTagResponse

Vote for tag

Vote for tag

PUT /tags/vote/:tagId

Returns

Interface: VoteTagResponse

Back to top

---

User

Request own User Information

Returns information about the current user, amount of Information depends on requested Scopes.

GET /user/self

Required OAuth Scopes: user.info

Returns

Interface: entityUserResponse

Back to top

---