Skip to content

Latest commit

 

History

History
144 lines (108 loc) · 5.78 KB

ModelTypeApi.md

File metadata and controls

144 lines (108 loc) · 5.78 KB
Raw

RadioManager\ModelTypeApi

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

Method HTTP request Description
getModelTypeById GET /model_types/{id} Get modelType by id
listModelTypes GET /model_types Get all modelTypes.

getModelTypeById

\RadioManager\Model\ModelTypeResult getModelTypeById($id, $_external_station_id)

Get modelType by id

Get modelType 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\ModelTypeApi(
    // 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 ModelType **(Required)**
$_external_station_id = 789; // int | Query on a different (content providing) station *(Optional)*

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

Parameters

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

Return type

\RadioManager\Model\ModelTypeResult

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]

listModelTypes

\RadioManager\Model\ModelTypeResults listModelTypes($page, $program_id, $broadcast_id, $item_id, $campaign_id, $presenter_id, $contact_id, $model, $limit, $order_by, $order_direction, $_external_station_id)

Get all modelTypes.

List all modelTypes.

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\ModelTypeApi(
    // 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)*
$program_id = 789; // int | Search on Program ID *(Optional)*
$broadcast_id = 789; // int | Search on Broadcast ID *(Optional)*
$item_id = 789; // int | Search on Item ID *(Optional)*
$campaign_id = 789; // int | Search on Campaign ID *(Optional)*
$presenter_id = 789; // int | Search on Presenter ID *(Optional)*
$contact_id = 789; // int | Search on Contact ID *(Optional)*
$model = "model_example"; // string | Search Modeltypes for certain Model *(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->listModelTypes($page, $program_id, $broadcast_id, $item_id, $campaign_id, $presenter_id, $contact_id, $model, $limit, $order_by, $order_direction, $_external_station_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelTypeApi->listModelTypes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int Current page (Optional) [optional]
program_id int Search on Program ID (Optional) [optional]
broadcast_id int Search on Broadcast ID (Optional) [optional]
item_id int Search on Item ID (Optional) [optional]
campaign_id int Search on Campaign ID (Optional) [optional]
presenter_id int Search on Presenter ID (Optional) [optional]
contact_id int Search on Contact ID (Optional) [optional]
model string Search Modeltypes for certain Model (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\ModelTypeResults

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]