RadioManager.Api.BroadcastApi

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

Method	HTTP request	Description
CreateBroadcast	POST /broadcasts	Create broadcast.
DeleteBroadcastById	DELETE /broadcasts/{id}	Delete broadcast by id
GetBroadcastById	GET /broadcasts/{id}	Get broadcast by id
GetCurrentBroadcast	GET /broadcasts/current	Get current Broadcast
GetDailyEPG	GET /broadcasts/epg/daily	Get daily EPG
GetEPGByDate	GET /broadcasts/epg	Get EPG by date
GetNextBroadcast	GET /broadcasts/next	Get next Broadcast
GetWeeklyEPG	GET /broadcasts/epg/weekly	Get weekly EPG
ListBroadcasts	GET /broadcasts	Get all broadcasts.
PrintBroadcastById	GET /broadcasts/print/{id}	Print broadcast by id with template
UpdateBroadcastByID	PATCH /broadcasts/{id}	Update broadcast by id

CreateBroadcast

PostSuccess CreateBroadcast (BroadcastDataInput data)

Create broadcast.

Example

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

namespace Example
{
    public class CreateBroadcastExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var data = new BroadcastDataInput(); // BroadcastDataInput | Data **(Required)**

            try
            {
                // Create broadcast.
                PostSuccess result = apiInstance.CreateBroadcast(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.CreateBroadcast: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
data	BroadcastDataInput	Data (Required)

Return type

PostSuccess

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteBroadcastById

Success DeleteBroadcastById (long? id)

Delete broadcast by id

Example

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

namespace Example
{
    public class DeleteBroadcastByIdExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var id = 789;  // long? | ID of Broadcast **(Required)**

            try
            {
                // Delete broadcast by id
                Success result = apiInstance.DeleteBroadcastById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.DeleteBroadcastById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?	ID of Broadcast (Required)

Return type

Success

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBroadcastById

BroadcastResult GetBroadcastById (long? id, long? externalStationId = null)

Get broadcast by id

Example

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

namespace Example
{
    public class GetBroadcastByIdExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

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

            try
            {
                // Get broadcast by id
                BroadcastResult result = apiInstance.GetBroadcastById(id, externalStationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.GetBroadcastById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?	ID of Broadcast (Required)
externalStationId	long?	Query on a different (content providing) station (Optional)	[optional]

Return type

BroadcastResult

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCurrentBroadcast

BroadcastResult GetCurrentBroadcast (bool? withunpublished = null)

Get current Broadcast

Example

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

namespace Example
{
    public class GetCurrentBroadcastExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var withunpublished = true;  // bool? | Show Unpublished *(Optional)* (optional) 

            try
            {
                // Get current Broadcast
                BroadcastResult result = apiInstance.GetCurrentBroadcast(withunpublished);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.GetCurrentBroadcast: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
withunpublished	bool?	Show Unpublished (Optional)	[optional]

Return type

BroadcastResult

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDailyEPG

EPGResults GetDailyEPG (DateTime? date = null, bool? withunpublished = null)

Get daily EPG

Get current Broadcast

Example

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

namespace Example
{
    public class GetDailyEPGExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var date = 2013-10-20T19:20:30+01:00;  // DateTime? | Date *(Optional)* (optional) 
            var withunpublished = true;  // bool? | Show Unpublished *(Optional)* (optional) 

            try
            {
                // Get daily EPG
                EPGResults result = apiInstance.GetDailyEPG(date, withunpublished);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.GetDailyEPG: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
date	DateTime?	Date (Optional)	[optional]
withunpublished	bool?	Show Unpublished (Optional)	[optional]

Return type

EPGResults

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEPGByDate

EPGResults GetEPGByDate (DateTime? date = null, bool? withunpublished = null)

Get EPG by date

Example

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

namespace Example
{
    public class GetEPGByDateExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var date = 2013-10-20T19:20:30+01:00;  // DateTime? | Date *(Optional)* (optional) 
            var withunpublished = true;  // bool? | Show Unpublished *(Optional)* (optional) 

            try
            {
                // Get EPG by date
                EPGResults result = apiInstance.GetEPGByDate(date, withunpublished);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.GetEPGByDate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
date	DateTime?	Date (Optional)	[optional]
withunpublished	bool?	Show Unpublished (Optional)	[optional]

Return type

EPGResults

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNextBroadcast

BroadcastResult GetNextBroadcast (bool? withunpublished = null)

Get next Broadcast

Example

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

namespace Example
{
    public class GetNextBroadcastExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var withunpublished = true;  // bool? | Show Unpublished *(Optional)* (optional) 

            try
            {
                // Get next Broadcast
                BroadcastResult result = apiInstance.GetNextBroadcast(withunpublished);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.GetNextBroadcast: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
withunpublished	bool?	Show Unpublished (Optional)	[optional]

Return type

BroadcastResult

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetWeeklyEPG

EPGResults GetWeeklyEPG (string date = null, bool? withunpublished = null)

Get weekly EPG

Example

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

namespace Example
{
    public class GetWeeklyEPGExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var date = date_example;  // string | Date *(Optional)* (optional) 
            var withunpublished = true;  // bool? | Show Unpublished *(Optional)* (optional) 

            try
            {
                // Get weekly EPG
                EPGResults result = apiInstance.GetWeeklyEPG(date, withunpublished);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.GetWeeklyEPG: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
date	string	Date (Optional)	[optional]
withunpublished	bool?	Show Unpublished (Optional)	[optional]

Return type

EPGResults

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListBroadcasts

BroadcastResults ListBroadcasts (long? page = null, long? programId = null, long? blockId = null, long? modelTypeId = null, long? tagId = null, long? presenterId = null, long? genreId = null, long? itemId = null, DateTime? startMin = null, DateTime? startMax = null, long? limit = null, string orderBy = null, string orderDirection = null, long? externalStationId = null)

Get all broadcasts.

List all broadcasts.

Example

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

namespace Example
{
    public class ListBroadcastsExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var page = 789;  // long? | Current page *(Optional)* (optional)  (default to 1)
            var programId = 789;  // long? | Search on Program ID *(Optional)* `(Relation)` (optional) 
            var blockId = 789;  // long? | Search on Block ID *(Optional)* `(Relation)` (optional) 
            var modelTypeId = 789;  // long? | Search on ModelType ID *(Optional)* `(Relation)` (optional) 
            var tagId = 789;  // long? | Search on Tag ID *(Optional)* `(Relation)` (optional) 
            var presenterId = 789;  // long? | Search on Presenter ID *(Optional)* `(Relation)` (optional) 
            var genreId = 789;  // long? | Search on Genre ID *(Optional)* `(Relation)` (optional) 
            var itemId = 789;  // long? | Search on Item ID *(Optional)* `(Relation)` (optional) 
            var startMin = 2013-10-20T19:20:30+01:00;  // DateTime? | Minimum start date *(Optional)* (optional) 
            var startMax = 2013-10-20T19:20:30+01:00;  // DateTime? | Maximum start date *(Optional)* (optional) 
            var limit = 789;  // long? | Results per page *(Optional)* (optional) 
            var orderBy = orderBy_example;  // string | Field to order the results *(Optional)* (optional) 
            var orderDirection = orderDirection_example;  // string | Direction of ordering *(Optional)* (optional) 
            var externalStationId = 789;  // long? | Query on a different (content providing) station *(Optional)* (optional) 

            try
            {
                // Get all broadcasts.
                BroadcastResults result = apiInstance.ListBroadcasts(page, programId, blockId, modelTypeId, tagId, presenterId, genreId, itemId, startMin, startMax, limit, orderBy, orderDirection, externalStationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.ListBroadcasts: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
page	long?	Current page (Optional)	[optional] [default to 1]
programId	long?	Search on Program ID (Optional) `(Relation)`	[optional]
blockId	long?	Search on Block ID (Optional) `(Relation)`	[optional]
modelTypeId	long?	Search on ModelType ID (Optional) `(Relation)`	[optional]
tagId	long?	Search on Tag ID (Optional) `(Relation)`	[optional]
presenterId	long?	Search on Presenter ID (Optional) `(Relation)`	[optional]
genreId	long?	Search on Genre ID (Optional) `(Relation)`	[optional]
itemId	long?	Search on Item ID (Optional) `(Relation)`	[optional]
startMin	DateTime?	Minimum start date (Optional)	[optional]
startMax	DateTime?	Maximum start date (Optional)	[optional]
limit	long?	Results per page (Optional)	[optional]
orderBy	string	Field to order the results (Optional)	[optional]
orderDirection	string	Direction of ordering (Optional)	[optional]
externalStationId	long?	Query on a different (content providing) station (Optional)	[optional]

Return type

BroadcastResults

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PrintBroadcastById

string PrintBroadcastById (long? id, long? templateId = null)

Print broadcast by id with template

Example

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

namespace Example
{
    public class PrintBroadcastByIdExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var id = 789;  // long? | ID of Broadcast **(Required)**
            var templateId = 789;  // long? | Search on template ID *(Optional)* (optional) 

            try
            {
                // Print broadcast by id with template
                string result = apiInstance.PrintBroadcastById(id, templateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.PrintBroadcastById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?	ID of Broadcast (Required)
templateId	long?	Search on template ID (Optional)	[optional]

Return type

string

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateBroadcastByID

Success UpdateBroadcastByID (long? id, BroadcastDataInput data = null)

Update broadcast by id

Example

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

namespace Example
{
    public class UpdateBroadcastByIDExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new BroadcastApi();
            var id = 789;  // long? | ID of Broadcast **(Required)**
            var data = new BroadcastDataInput(); // BroadcastDataInput | Data *(Optional)* (optional) 

            try
            {
                // Update broadcast by id
                Success result = apiInstance.UpdateBroadcastByID(id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BroadcastApi.UpdateBroadcastByID: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?	ID of Broadcast (Required)
data	BroadcastDataInput	Data (Optional)	[optional]

Return type

Success

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

BroadcastApi.md

Latest commit

History

BroadcastApi.md

File metadata and controls

RadioManager.Api.BroadcastApi

CreateBroadcast

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteBroadcastById

Example

Parameters

Return type

Authorization

HTTP request headers

GetBroadcastById

Example

Parameters

Return type

Authorization

HTTP request headers

GetCurrentBroadcast

Example

Parameters

Return type

Authorization

HTTP request headers

GetDailyEPG

Example

Parameters

Return type

Authorization

HTTP request headers

GetEPGByDate

Example

Parameters

Return type

Authorization

HTTP request headers

GetNextBroadcast

Example

Parameters

Return type

Authorization

HTTP request headers

GetWeeklyEPG

Example

Parameters

Return type

Authorization

HTTP request headers

ListBroadcasts

Example

Parameters

Return type

Authorization

HTTP request headers

PrintBroadcastById

Example

Parameters

Return type

Authorization

HTTP request headers

UpdateBroadcastByID

Example

Parameters

Return type

Authorization

HTTP request headers