radiomanager_client

RadioManagerClient - the Ruby gem for the RadioManager

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

Installation

To install the ruby package, run the following command:

gem install radiomanager_client

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'radiomanager_client'

# Setup authorization
RadioManagerClient.configure do |config|
  # Configure API key authorization: API Key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = RadioManagerClient::BlockApi.new

id = 789 # Integer | ID of Block **(Required)**

opts = { 
  _external_station_id: 789 # Integer | Query on a different (content providing) station *(Optional)*
}

begin
  #Get block by id
  result = api_instance.get_block_by_id(id, opts)
  p result
rescue RadioManagerClient::ApiError => e
  puts "Exception when calling BlockApi->get_block_by_id: #{e}"
end

Documentation for API Endpoints

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

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

Documentation for Models

Documentation for Authorization

API Key

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