DEPRICATED

Pluxbox RadioManager Client

RadioManager

• API version: 2.0 For more information, please visit https://pluxbox.com

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

To install the python package, run the following command:

pip install Pluxbox-RadioManager-Python-SDK

Then import the package:

import radiomanager_sdk 

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import radiomanager_sdk
from radiomanager_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: API Key
radiomanager_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# radiomanager_sdk.configuration.api_key_prefix['api-key'] = 'Bearer'
# create an instance of the API class
api_instance = radiomanager_sdk.BlockApi()
id = 789 # int | ID of Block **(Required)**
external_station_id = 789 # int | Query on a different (content providing) station *(Optional)* (optional)

try:
    # Get block by id
    api_response = api_instance.get_block_by_id(id, external_station_id=external_station_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlockApi->get_block_by_id: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://radiomanager.io/api/v2

Class	Method	HTTP request	Description
BlockApi	get_block_by_id	GET /blocks/{id}	Get block by id
BlockApi	get_current_block	GET /blocks/current	Get current Block
BlockApi	get_next_block	GET /blocks/next	Get upcoming Block
BlockApi	list_blocks	GET /blocks	Get a list of all blocks currently in your station.
BroadcastApi	create_broadcast	POST /broadcasts	Create broadcast.
BroadcastApi	delete_broadcast_by_id	DELETE /broadcasts/{id}	Delete broadcast by id
BroadcastApi	get_broadcast_by_id	GET /broadcasts/{id}	Get broadcast by id
BroadcastApi	get_current_broadcast	GET /broadcasts/current	Get current Broadcast
BroadcastApi	get_daily_epg	GET /broadcasts/epg/daily	Get daily EPG
BroadcastApi	get_epg_by_date	GET /broadcasts/epg	Get EPG by date
BroadcastApi	get_next_broadcast	GET /broadcasts/next	Get next Broadcast
BroadcastApi	get_weekly_epg	GET /broadcasts/epg/weekly	Get weekly EPG
BroadcastApi	list_broadcasts	GET /broadcasts	Get all broadcasts.
BroadcastApi	print_broadcast_by_id	GET /broadcasts/print/{id}	Print broadcast by id with template
BroadcastApi	update_broadcast_by_id	PATCH /broadcasts/{id}	Update broadcast by id
CampaignApi	create_campaign	POST /campaigns	Create campaign.
CampaignApi	delete_campaign_by_id	DELETE /campaigns/{id}	Delete campaign by id
CampaignApi	get_campaign_by_id	GET /campaigns/{id}	Get campaign by id
CampaignApi	list_campaigns	GET /campaigns	Get all campaigns.
CampaignApi	update_campaign_by_id	PATCH /campaigns/{id}	Update campaign by id
ContactApi	create_contact	POST /contacts	Create contact.
ContactApi	delete_contact_by_id	DELETE /contacts/{id}	Delete contact by id
ContactApi	get_contact_by_id	GET /contacts/{id}	Get contact by id
ContactApi	list_contacts	GET /contacts	Get all contacts.
ContactApi	update_contact_by_id	PATCH /contacts/{id}	Update contact by id
GenreApi	get_genre_by_id	GET /genres/{id}	Get genre by id
GenreApi	list_genres	GET /genres	List all genres.
ItemApi	create_item	POST /items	Create an new item.
ItemApi	current_item_post_structure	POST /items/current/structure	Post a current playing item, keep structure
ItemApi	current_item_post_timing	POST /items/current/timing	Post a current playing item
ItemApi	delete_item_by_id	DELETE /items/{id}	Delete item by ID.
ItemApi	get_current_item	GET /items/current	Get current Item
ItemApi	get_item_by_id	GET /items/{id}	Get extended item details by ID.
ItemApi	list_items	GET /items	Get a list of all the items currently in your station.
ItemApi	playlist_post_merge	POST /items/playlist/merge	Post a playlist, do not remove previously imported items
ItemApi	playlist_post_structure	POST /items/playlist/structure	Post a playlist, keep current structure
ItemApi	playlist_post_timing	POST /items/playlist/timing	Post a playlist
ItemApi	stop_current_item	POST /items/stopcurrent	Stop an Item
ItemApi	update_item_by_id	PATCH /items/{id}	Update extended item details by ID.
ModelTypeApi	get_model_type_by_id	GET /model_types/{id}	Get modelType by id
ModelTypeApi	list_model_types	GET /model_types	Get all modelTypes.
PresenterApi	create_presenter	POST /presenters	Create presenter.
PresenterApi	delete_presenter_by_id	DELETE /presenters/{id}	Delete presenter by id
PresenterApi	get_presenter_by_id	GET /presenters/{id}	Get presenter by id
PresenterApi	list_presenters	GET /presenters	Get all presenters.
PresenterApi	update_presenter_by_id	PATCH /presenters/{id}	Update presenter by id
ProgramApi	create_program	POST /programs	Create program.
ProgramApi	delete_program_by_id	DELETE /programs/{id}	Delete program by id
ProgramApi	get_program_by_id	GET /programs/{id}	Get program by id
ProgramApi	list_programs	GET /programs	Get all programs.
ProgramApi	update_program_by_id	PATCH /programs/{id}	Update program by id
StationApi	get_station	GET /station	Get own station only
StoryApi	create_story	POST /stories	Create story.
StoryApi	delete_story_by_id	DELETE /stories/{id}	Delete story by id
StoryApi	get_story_by_id	GET /stories/{id}	Get story by id
StoryApi	list_stories	GET /stories	Get all stories.
StoryApi	update_story_by_id	PATCH /stories/{id}	Update story by id
StringApi	get_strings_by_name	GET /strings/{name}	Get Strings (formatted)
TagApi	create_tag	POST /tags	Create tag.
TagApi	delete_tag_by_id	DELETE /tags/{id}	Delete tag by id
TagApi	get_tag_by_id	GET /tags/{id}	Get tags by id
TagApi	list_tags	GET /tags	Get a list of all the tags currently in your station.
TagApi	update_tag_by_id	PATCH /tags/{id}	Update tag by id
UserApi	delete_user_by_id	DELETE /users/{id}	Remove user from station by Id
UserApi	get_user_by_id	GET /users/{id}	Get user by id
UserApi	invite_user_by_mail	POST /users/invite	Invite user by mail
UserApi	list_users	GET /users	Get all users.
VisualSlideApi	get_visual_slide	GET /visual	Get Visual Slide Image as Base64

Documentation For Models

• Block
• BlockRelations
• BlockRelationsBroadcast
• BlockRelationsBroadcastParams
• BlockRelationsItems
• BlockRelationsItemsParams
• BlockRelationsProgram
• BlockResults
• Broadcast
• BroadcastEPGDay
• BroadcastEPGRelations
• BroadcastInputOnly
• BroadcastOutputOnly
• BroadcastRelations
• BroadcastRelationsBlocks
• BroadcastRelationsGenre
• BroadcastRelationsItems
• BroadcastRelationsItemsParams
• BroadcastRelationsModelType
• BroadcastRelationsPresenters
• BroadcastRelationsTags
• BroadcastResults
• Campaign
• CampaignOutputOnly
• CampaignRelations
• CampaignRelationsItems
• CampaignRelationsItemsParams
• CampaignResults
• CampaignTemplateItem
• Contact
• ContactOutputOnly
• ContactRelations
• ContactRelationsItems
• ContactRelationsTags
• ContactRelationsTagsParams
• ContactResults
• Data
• Data1
• Data2
• Data3
• EPGResults
• Forbidden
• Genre
• GenreOutputOnly
• GenreRelations
• GenreRelationsBroadcasts
• GenreRelationsBroadcastsParams
• GenreRelationsPrograms
• GenreResults
• ImportItem
• InlineResponse202
• InternalServerError
• InviteUserData
• InviteUserSuccess
• Item
• ItemInputOnly
• ItemOutputOnly
• ItemRelations
• ItemRelationsBlock
• ItemRelationsCampaign
• ItemRelationsContacts
• ItemRelationsContactsParams
• ItemRelationsProgram
• ItemRelationsTags
• ItemResults
• ModelType
• ModelTypeOptions
• ModelTypeOutputOnly
• ModelTypeRelations
• ModelTypeRelationsBroadcasts
• ModelTypeRelationsCampaigns
• ModelTypeRelationsCampaignsParams
• ModelTypeRelationsContacts
• ModelTypeRelationsItems
• ModelTypeRelationsPresenters
• ModelTypeRelationsPrograms
• ModelTypeResults
• NotFound
• PostSuccess
• Presenter
• PresenterOutputOnly
• PresenterRelations
• PresenterRelationsBroadcasts
• PresenterRelationsPrograms
• PresenterRelationsProgramsParams
• PresenterResults
• Program
• ProgramInputOnly
• ProgramOutputOnly
• ProgramRelations
• ProgramRelationsBlocks
• ProgramRelationsBroadcasts
• ProgramRelationsItems
• ProgramRelationsItemsParams
• ProgramRelationsPresenters
• ProgramRelationsTags
• ProgramResults
• ReadOnly
• RelationsPlaceholder
• StationResult
• StationResultStation
• StationResultStationStartDays
• Story
• StoryInputOnly
• StoryOutputOnly
• StoryRelations
• StoryRelationsItems
• StoryRelationsTags
• StoryRelationsTagsParams
• StoryResults
• Success
• Tag
• TagOutputOnly
• TagRelations
• TagRelationsBroadcasts
• TagRelationsBroadcastsParams
• TagRelationsContacts
• TagRelationsItems
• TagRelationsPrograms
• TagResults
• TextString
• TooManyRequests
• UnprocessableEntity
• UserResult
• UserResultRoles
• UserResultSettings
• UserResults
• VisualResult
• BlockResult
• BroadcastDataInput
• BroadcastEPGResult
• BroadcastResult
• CampaignDataInput
• CampaignResult
• ContactDataInput
• ContactResult
• GenreResult
• ItemDataInput
• ItemResult
• ModelTypeResult
• PresenterDataInput
• PresenterEPGResult
• PresenterResult
• ProgramDataInput
• ProgramResult
• StoryDataInput
• StoryResult
• TagDataInput
• TagResult

Documentation For Authorization

API Key

• Type: API key
• API key parameter name: api-key
• Location: HTTP header

Author

support@pluxbox.com