RadioManager\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

\RadioManager\Model\PostSuccess createBroadcast($data)

Create broadcast.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$data = new \RadioManager\Model\BroadcastDataInput(); // \RadioManager\Model\BroadcastDataInput | Data **(Required)**

try {
    $result = $apiInstance->createBroadcast($data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->createBroadcast: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
data	\RadioManager\Model\BroadcastDataInput	Data (Required)

Return type

\RadioManager\Model\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

\RadioManager\Model\Success deleteBroadcastById($id)

Delete broadcast by id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 789; // int | ID of Broadcast **(Required)**

try {
    $result = $apiInstance->deleteBroadcastById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->deleteBroadcastById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of Broadcast (Required)

Return type

\RadioManager\Model\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

\RadioManager\Model\BroadcastResult getBroadcastById($id, $_external_station_id)

Get broadcast by id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 789; // int | ID of Broadcast **(Required)**
$_external_station_id = 789; // int | Query on a different (content providing) station *(Optional)*

try {
    $result = $apiInstance->getBroadcastById($id, $_external_station_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->getBroadcastById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\RadioManager\Model\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

\RadioManager\Model\BroadcastResult getCurrentBroadcast($withunpublished)

Get current Broadcast

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$withunpublished = true; // bool | Show Unpublished *(Optional)*

try {
    $result = $apiInstance->getCurrentBroadcast($withunpublished);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->getCurrentBroadcast: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\RadioManager\Model\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

\RadioManager\Model\EPGResults getDailyEPG($date, $withunpublished)

Get daily EPG

Get current Broadcast

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Date *(Optional)*
$withunpublished = true; // bool | Show Unpublished *(Optional)*

try {
    $result = $apiInstance->getDailyEPG($date, $withunpublished);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->getDailyEPG: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\RadioManager\Model\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

\RadioManager\Model\EPGResults getEPGByDate($date, $withunpublished)

Get EPG by date

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Date *(Optional)*
$withunpublished = true; // bool | Show Unpublished *(Optional)*

try {
    $result = $apiInstance->getEPGByDate($date, $withunpublished);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->getEPGByDate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\RadioManager\Model\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

\RadioManager\Model\BroadcastResult getNextBroadcast($withunpublished)

Get next Broadcast

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$withunpublished = true; // bool | Show Unpublished *(Optional)*

try {
    $result = $apiInstance->getNextBroadcast($withunpublished);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->getNextBroadcast: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\RadioManager\Model\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

\RadioManager\Model\EPGResults getWeeklyEPG($date, $withunpublished)

Get weekly EPG

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$date = "date_example"; // string | Date *(Optional)*
$withunpublished = true; // bool | Show Unpublished *(Optional)*

try {
    $result = $apiInstance->getWeeklyEPG($date, $withunpublished);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->getWeeklyEPG: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\RadioManager\Model\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

\RadioManager\Model\BroadcastResults listBroadcasts($page, $program_id, $block_id, $model_type_id, $tag_id, $presenter_id, $genre_id, $item_id, $start_min, $start_max, $limit, $order_by, $order_direction, $_external_station_id)

Get all broadcasts.

List all broadcasts.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int | Current page *(Optional)*
$program_id = 789; // int | Search on Program ID *(Optional)* `(Relation)`
$block_id = 789; // int | Search on Block ID *(Optional)* `(Relation)`
$model_type_id = 789; // int | Search on ModelType ID *(Optional)* `(Relation)`
$tag_id = 789; // int | Search on Tag ID *(Optional)* `(Relation)`
$presenter_id = 789; // int | Search on Presenter ID *(Optional)* `(Relation)`
$genre_id = 789; // int | Search on Genre ID *(Optional)* `(Relation)`
$item_id = 789; // int | Search on Item ID *(Optional)* `(Relation)`
$start_min = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Minimum start date *(Optional)*
$start_max = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Maximum start date *(Optional)*
$limit = 789; // int | Results per page *(Optional)*
$order_by = "order_by_example"; // string | Field to order the results *(Optional)*
$order_direction = "order_direction_example"; // string | Direction of ordering *(Optional)*
$_external_station_id = 789; // int | Query on a different (content providing) station *(Optional)*

try {
    $result = $apiInstance->listBroadcasts($page, $program_id, $block_id, $model_type_id, $tag_id, $presenter_id, $genre_id, $item_id, $start_min, $start_max, $limit, $order_by, $order_direction, $_external_station_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->listBroadcasts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
page	int	Current page (Optional)	[optional] [default to 1]
program_id	int	Search on Program ID (Optional) `(Relation)`	[optional]
block_id	int	Search on Block ID (Optional) `(Relation)`	[optional]
model_type_id	int	Search on ModelType ID (Optional) `(Relation)`	[optional]
tag_id	int	Search on Tag ID (Optional) `(Relation)`	[optional]
presenter_id	int	Search on Presenter ID (Optional) `(Relation)`	[optional]
genre_id	int	Search on Genre ID (Optional) `(Relation)`	[optional]
item_id	int	Search on Item ID (Optional) `(Relation)`	[optional]
start_min	\DateTime	Minimum start date (Optional)	[optional]
start_max	\DateTime	Maximum start date (Optional)	[optional]
limit	int	Results per page (Optional)	[optional]
order_by	string	Field to order the results (Optional)	[optional]
order_direction	string	Direction of ordering (Optional)	[optional]
_external_station_id	int	Query on a different (content providing) station (Optional)	[optional]

Return type

\RadioManager\Model\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($id, $template_id)

Print broadcast by id with template

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 789; // int | ID of Broadcast **(Required)**
$template_id = 789; // int | Search on template ID *(Optional)*

try {
    $result = $apiInstance->printBroadcastById($id, $template_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->printBroadcastById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of Broadcast (Required)
template_id	int	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

\RadioManager\Model\Success updateBroadcastByID($id, $data)

Update broadcast by id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BroadcastApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 789; // int | ID of Broadcast **(Required)**
$data = new \RadioManager\Model\BroadcastDataInput(); // \RadioManager\Model\BroadcastDataInput | Data *(Optional)*

try {
    $result = $apiInstance->updateBroadcastByID($id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadcastApi->updateBroadcastByID: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of Broadcast (Required)
data	\RadioManager\Model\BroadcastDataInput	Data (Optional)	[optional]

Return type

\RadioManager\Model\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\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