Skip to content

Pluxbox/radiomanager-csharp-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
docs
docs
 
 
src
src
 
 
.gitignore
.gitignore
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
RadioManager.sln
RadioManager.sln
 
 
build.bat
build.bat
 
 
build.sh
build.sh
 
 
mono_nunit_test.sh
mono_nunit_test.sh
 
 

Repository files navigation

RadioManager - the C# library for the RadioManager

Pluxbox RadioManager gives you the power, flexibility and speed you always wanted in a lightweight and easy-to-use web-based radio solution. With Pluxbox RadioManager you can organise your radio workflow and automate your omnichannel communication with your listeners. We offer wide range specialised services for the radio and connections like Hybrid Radio, Visual Radio, your website and social media without losing focus on your broadcast. For more information visit: pluxbox.com

  • API version: 2.0
  • SDK version: 1.1.12
  • Build package: io.swagger.codegen.languages.CSharpClientCodegen For more information, please visit https://pluxbox.com

Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

Dependencies

The DLLs included in the package may not be the latest version. We recommend using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using RadioManager.Api;
using RadioManager.Client;
using RadioManager.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out RadioManager.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System;
using System.Diagnostics;
using RadioManager.Api;
using RadioManager.Client;
using RadioManager.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {

            // Configure API key authorization: API Key
            Configuration.Default.ApiKey.Add("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api-key", "Bearer");

            var apiInstance = new BlockApi();
            var id = 789;  // long? | ID of Block **(Required)**
            var externalStationId = 789;  // long? | Query on a different (content providing) station *(Optional)* (optional) 

            try
            {
                // Get block by id
                BlockResult result = apiInstance.GetBlockById(id, externalStationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlockApi.GetBlockById: " + e.Message );
            }

        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
BlockApi GetBlockById GET /blocks/{id} Get block by id
BlockApi GetCurrentBlock GET /blocks/current Get current Block
BlockApi GetNextBlock GET /blocks/next Get upcoming Block
BlockApi ListBlocks GET /blocks Get a list of all blocks currently in your station.
BroadcastApi CreateBroadcast POST /broadcasts Create broadcast.
BroadcastApi DeleteBroadcastById DELETE /broadcasts/{id} Delete broadcast by id
BroadcastApi GetBroadcastById GET /broadcasts/{id} Get broadcast by id
BroadcastApi GetCurrentBroadcast GET /broadcasts/current Get current Broadcast
BroadcastApi GetDailyEPG GET /broadcasts/epg/daily Get daily EPG
BroadcastApi GetEPGByDate GET /broadcasts/epg Get EPG by date
BroadcastApi GetNextBroadcast GET /broadcasts/next Get next Broadcast
BroadcastApi GetWeeklyEPG GET /broadcasts/epg/weekly Get weekly EPG
BroadcastApi ListBroadcasts GET /broadcasts Get all broadcasts.
BroadcastApi PrintBroadcastById GET /broadcasts/print/{id} Print broadcast by id with template
BroadcastApi UpdateBroadcastByID PATCH /broadcasts/{id} Update broadcast by id
CampaignApi CreateCampaign POST /campaigns Create campaign.
CampaignApi DeleteCampaignById DELETE /campaigns/{id} Delete campaign by id
CampaignApi GetCampaignById GET /campaigns/{id} Get campaign by id
CampaignApi ListCampaigns GET /campaigns Get all campaigns.
CampaignApi UpdateCampaignByID PATCH /campaigns/{id} Update campaign by id
ContactApi CreateContact POST /contacts Create contact.
ContactApi DeleteContactById DELETE /contacts/{id} Delete contact by id
ContactApi GetContactById GET /contacts/{id} Get contact by id
ContactApi ListContacts GET /contacts Get all contacts.
ContactApi UpdateContactByID PATCH /contacts/{id} Update contact by id
GenreApi GetGenreById GET /genres/{id} Get genre by id
GenreApi ListGenres GET /genres List all genres.
ItemApi CreateItem POST /items Create an new item.
ItemApi CurrentItemPostStructure POST /items/current/structure Post a current playing item, keep structure
ItemApi CurrentItemPostTiming POST /items/current/timing Post a current playing item
ItemApi DeleteItemById DELETE /items/{id} Delete item by ID.
ItemApi GetCurrentItem GET /items/current Get current Item
ItemApi GetItemById GET /items/{id} Get extended item details by ID.
ItemApi ListItems GET /items Get a list of all the items currently in your station.
ItemApi PlaylistPostMerge POST /items/playlist/merge Post a playlist, do not remove previously imported items
ItemApi PlaylistPostStructure POST /items/playlist/structure Post a playlist, keep current structure
ItemApi PlaylistPostTiming POST /items/playlist/timing Post a playlist
ItemApi StopCurrentItem POST /items/stopcurrent Stop an Item
ItemApi UpdateItemById PATCH /items/{id} Update extended item details by ID.
ModelTypeApi GetModelTypeById GET /model_types/{id} Get modelType by id
ModelTypeApi ListModelTypes GET /model_types Get all modelTypes.
PresenterApi CreatePresenter POST /presenters Create presenter.
PresenterApi DeletePresenterById DELETE /presenters/{id} Delete presenter by id
PresenterApi GetPresenterById GET /presenters/{id} Get presenter by id
PresenterApi ListPresenters GET /presenters Get all presenters.
PresenterApi UpdatePresenterByID PATCH /presenters/{id} Update presenter by id
ProgramApi CreateProgram POST /programs Create program.
ProgramApi DeleteProgramById DELETE /programs/{id} Delete program by id
ProgramApi GetProgramById GET /programs/{id} Get program by id
ProgramApi ListPrograms GET /programs Get all programs.
ProgramApi UpdateProgramByID PATCH /programs/{id} Update program by id
StationApi GetStation GET /station Get own station only
StoryApi CreateStory POST /stories Create story.
StoryApi DeleteStoryById DELETE /stories/{id} Delete story by id
StoryApi GetStoryById GET /stories/{id} Get story by id
StoryApi ListStories GET /stories Get all stories.
StoryApi UpdateStoryByID PATCH /stories/{id} Update story by id
StringApi GetStringsByName GET /strings/{name} Get Strings (formatted)
TagApi CreateTag POST /tags Create tag.
TagApi DeleteTagById DELETE /tags/{id} Delete tag by id
TagApi GetTagById GET /tags/{id} Get tags by id
TagApi ListTags GET /tags Get a list of all the tags currently in your station.
TagApi UpdateTagByID PATCH /tags/{id} Update tag by id
UserApi DeleteUserById DELETE /users/{id} Remove user from station by Id
UserApi GetUserById GET /users/{id} Get user by id
UserApi InviteUserByMail POST /users/invite Invite user by mail
UserApi ListUsers GET /users Get all users.
VisualSlideApi GetVisualSlide 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

About

Pluxbox RadioManager C# client for API v2

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

6 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Contributors 5

Languages