All URIs are relative to https://radiomanager.io/api/v2
| Method | HTTP request | Description |
|---|---|---|
| createItem | POST /items | Create an new item. |
| currentItemPostStructure | POST /items/current/structure | Post a current playing item, keep structure |
| currentItemPostTiming | POST /items/current/timing | Post a current playing item |
| deleteItemById | DELETE /items/{id} | Delete item by ID. |
| getCurrentItem | GET /items/current | Get current Item |
| getItemById | GET /items/{id} | Get extended item details by ID. |
| listItems | GET /items | Get a list of all the items currently in your station. |
| playlistPostMerge | POST /items/playlist/merge | Post a playlist, do not remove previously imported items |
| playlistPostStructure | POST /items/playlist/structure | Post a playlist, keep current structure |
| playlistPostTiming | POST /items/playlist/timing | Post a playlist |
| stopCurrentItem | POST /items/stopcurrent | Stop an Item |
| updateItemById | PATCH /items/{id} | Update extended item details by ID. |
\RadioManager\Model\PostSuccess createItem($data)
Create an new item.
Create item.
<?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\ItemApi(
// 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\ItemDataInput(); // \RadioManager\Model\ItemDataInput | Data *(Optional)*
try {
$result = $apiInstance->createItem($data);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->createItem: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| data | \RadioManager\Model\ItemDataInput | Data (Optional) | [optional] |
\RadioManager\Model\PostSuccess
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\Success currentItemPostStructure($data)
Post a current playing item, keep structure
Post a current playing item, keep structure
<?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\ItemApi(
// 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\ImportItem(); // \RadioManager\Model\ImportItem | Data *(Optional)*
try {
$result = $apiInstance->currentItemPostStructure($data);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->currentItemPostStructure: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| data | \RadioManager\Model\ImportItem | Data (Optional) | [optional] |
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\Success currentItemPostTiming($data)
Post a current playing item
Post a current playing item
<?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\ItemApi(
// 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\ImportItem(); // \RadioManager\Model\ImportItem | Data *(Optional)*
try {
$result = $apiInstance->currentItemPostTiming($data);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->currentItemPostTiming: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| data | \RadioManager\Model\ImportItem | Data (Optional) | [optional] |
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\Success deleteItemById($id)
Delete item by ID.
Delete item by id.
<?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\ItemApi(
// 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 Item **(Required)**
try {
$result = $apiInstance->deleteItemById($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->deleteItemById: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of Item (Required) |
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\ItemResult getCurrentItem($lastplayed)
Get current Item
Get current Item
<?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\ItemApi(
// 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
);
$lastplayed = true; // bool | Show last played item if there is no current item*(Optional)*
try {
$result = $apiInstance->getCurrentItem($lastplayed);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->getCurrentItem: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| lastplayed | bool | Show last played item if there is no current item*(Optional)* | [optional] |
\RadioManager\Model\ItemResult
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\ItemResult getItemById($id, $_external_station_id)
Get extended item details by ID.
Read item by id.
<?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\ItemApi(
// 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 Item **(Required)**
$_external_station_id = 789; // int | Query on a different (content providing) station *(Optional)*
try {
$result = $apiInstance->getItemById($id, $_external_station_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->getItemById: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of Item (Required) | |
| _external_station_id | int | Query on a different (content providing) station (Optional) | [optional] |
\RadioManager\Model\ItemResult
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\ItemResults listItems($page, $block_id, $broadcast_id, $model_type_id, $tag_id, $campaign_id, $contact_id, $program_draft_id, $user_draft_id, $station_draft_id, $program_id, $external_id, $start_min, $start_max, $duration_min, $duration_max, $status, $limit, $order_by, $order_direction, $_external_station_id)
Get a list of all the items currently in your station.
Get a list of all the items currently in your station. This feature supports pagination and will give a maximum results of 50 items back.
<?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\ItemApi(
// 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 = 789; // int | Current page *(Optional)*
$block_id = 789; // int | Search on Block ID *(Optional)* `(Relation)`
$broadcast_id = 789; // int | Search on Broadcast ID *(Optional)* `(Relation)`
$model_type_id = 789; // int | Search on ModelType ID *(Optional)* `(Relation)`
$tag_id = 789; // int | Search on Tag ID *(Optional)* `(Relation)`
$campaign_id = 789; // int | Search on Campaign ID *(Optional)* `(Relation)`
$contact_id = 789; // int | Search on Contact ID *(Optional)* `(Relation)`
$program_draft_id = 789; // int | Search on Program Draft ID *(Optional)*
$user_draft_id = 789; // int | Search on User Draft ID *(Optional)*
$station_draft_id = 789; // int | Search on Station Draft ID *(Optional)*
$program_id = 789; // int | Search on Program ID *(Optional)* `(Relation)`
$external_id = "external_id_example"; // string | Search on External ID *(Optional)*
$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)*
$duration_min = 56; // int | Minimum duration (seconds) *(Optional)*
$duration_max = 56; // int | Maximum duration (seconds) *(Optional)*
$status = "status_example"; // string | Play Status of item *(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->listItems($page, $block_id, $broadcast_id, $model_type_id, $tag_id, $campaign_id, $contact_id, $program_draft_id, $user_draft_id, $station_draft_id, $program_id, $external_id, $start_min, $start_max, $duration_min, $duration_max, $status, $limit, $order_by, $order_direction, $_external_station_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->listItems: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| page | int | Current page (Optional) | [optional] |
| block_id | int | Search on Block ID (Optional) `(Relation)` | [optional] |
| broadcast_id | int | Search on Broadcast 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] |
| campaign_id | int | Search on Campaign ID (Optional) `(Relation)` | [optional] |
| contact_id | int | Search on Contact ID (Optional) `(Relation)` | [optional] |
| program_draft_id | int | Search on Program Draft ID (Optional) | [optional] |
| user_draft_id | int | Search on User Draft ID (Optional) | [optional] |
| station_draft_id | int | Search on Station Draft ID (Optional) | [optional] |
| program_id | int | Search on Program ID (Optional) `(Relation)` | [optional] |
| external_id | string | Search on External ID (Optional) | [optional] |
| start_min | \DateTime | Minimum start date (Optional) | [optional] |
| start_max | \DateTime | Maximum start date (Optional) | [optional] |
| duration_min | int | Minimum duration (seconds) (Optional) | [optional] |
| duration_max | int | Maximum duration (seconds) (Optional) | [optional] |
| status | string | Play Status of item (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] |
\RadioManager\Model\ItemResults
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\InlineResponse202 playlistPostMerge($data)
Post a playlist, do not remove previously imported items
Post a playlist, do not remove previously imported items
<?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\ItemApi(
// 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\Data2(); // \RadioManager\Model\Data2 | Data *(Optional)*
try {
$result = $apiInstance->playlistPostMerge($data);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->playlistPostMerge: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| data | \RadioManager\Model\Data2 | Data (Optional) | [optional] |
\RadioManager\Model\InlineResponse202
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\InlineResponse202 playlistPostStructure($data)
Post a playlist, keep current structure
Post a playlist, keep current structure
<?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\ItemApi(
// 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\Data1(); // \RadioManager\Model\Data1 | Data *(Optional)*
try {
$result = $apiInstance->playlistPostStructure($data);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->playlistPostStructure: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| data | \RadioManager\Model\Data1 | Data (Optional) | [optional] |
\RadioManager\Model\InlineResponse202
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\InlineResponse202 playlistPostTiming($data)
Post a playlist
Post a playlist
<?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\ItemApi(
// 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\Data(); // \RadioManager\Model\Data | Data *(Optional)*
try {
$result = $apiInstance->playlistPostTiming($data);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->playlistPostTiming: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| data | \RadioManager\Model\Data | Data (Optional) | [optional] |
\RadioManager\Model\InlineResponse202
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\Success stopCurrentItem($data)
Stop an Item
Set a current playing or specific item on played
<?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\ItemApi(
// 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\Data3(); // \RadioManager\Model\Data3 | Data *(Optional)*
try {
$result = $apiInstance->stopCurrentItem($data);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->stopCurrentItem: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| data | \RadioManager\Model\Data3 | Data (Optional) | [optional] |
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\RadioManager\Model\Success updateItemById($id, $data)
Update extended item details by ID.
Update item by id.
<?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\ItemApi(
// 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 Item **(Required)**
$data = new \RadioManager\Model\ItemDataInput(); // \RadioManager\Model\ItemDataInput | Data *(Optional)*
try {
$result = $apiInstance->updateItemById($id, $data);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->updateItemById: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of Item (Required) | |
| data | \RadioManager\Model\ItemDataInput | Data (Optional) | [optional] |
[API Key](../../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]