Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 2.08 KB

StringApi.md

File metadata and controls

66 lines (46 loc) · 2.08 KB

RadioManager\StringApi

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

Method HTTP request Description
getStringsByName GET /strings/{name} Get Strings (formatted)

getStringsByName

\RadioManager\Model\TextString getStringsByName($name, $full_model)

Get Strings (formatted)

Get Strings (formatted)

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\StringApi(
    // 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
);
$name = "name_example"; // string | Name of Strings **(Required)**
$full_model = true; // bool | Full model or content only **(Required)**

try {
    $result = $apiInstance->getStringsByName($name, $full_model);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StringApi->getStringsByName: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
name string Name of Strings (Required)
full_model bool Full model or content only (Required) [default to true]

Return type

\RadioManager\Model\TextString

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]