Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.84 KB

StringApi.md

File metadata and controls

67 lines (46 loc) · 1.84 KB

RadioManagerClient::StringApi

Load the API package

use RadioManagerClient::Object::StringApi;

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

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

get_strings_by_name

TextString get_strings_by_name(name => $name, full_model => $full_model)

Get Strings (formatted)

Get Strings (formatted)

Example

use Data::Dumper;
use RadioManagerClient::StringApi;
my $api_instance = RadioManagerClient::StringApi->new(

    # Configure API key authorization: API Key
    api_key => {'api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'api-key' => 'Bearer'},
);

my $name = 'name_example'; # string | Name of Strings **(Required)**
my $full_model = 1; # boolean | Full model or content only **(Required)**

eval { 
    my $result = $api_instance->get_strings_by_name(name => $name, full_model => $full_model);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StringApi->get_strings_by_name: $@\n";
}

Parameters

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

Return type

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]