Skip to content

Latest commit

 

History

History
133 lines (96 loc) · 4.69 KB

GenreApi.md

File metadata and controls

133 lines (96 loc) · 4.69 KB

RadioManagerClient::GenreApi

Load the API package

use RadioManagerClient::Object::GenreApi;

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

Method HTTP request Description
get_genre_by_id GET /genres/{id} Get genre by id
list_genres GET /genres List all genres.

get_genre_by_id

GenreResult get_genre_by_id(id => $id, _external_station_id => $_external_station_id)

Get genre by id

Get genre by id

Example

use Data::Dumper;
use RadioManagerClient::GenreApi;
my $api_instance = RadioManagerClient::GenreApi->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 $id = 789; # int | ID of Genre **(Required)**
my $_external_station_id = 789; # int | Query on a different (content providing) station *(Optional)*

eval { 
    my $result = $api_instance->get_genre_by_id(id => $id, _external_station_id => $_external_station_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GenreApi->get_genre_by_id: $@\n";
}

Parameters

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

Return type

GenreResult

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]

list_genres

GenreResults list_genres(page => $page, parent_id => $parent_id, program_id => $program_id, broadcast_id => $broadcast_id, limit => $limit, order_by => $order_by, order_direction => $order_direction, _external_station_id => $_external_station_id)

List all genres.

List all genres.

Example

use Data::Dumper;
use RadioManagerClient::GenreApi;
my $api_instance = RadioManagerClient::GenreApi->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 $page = 789; # int | Current page *(Optional)*
my $parent_id = 789; # int | Search on Parent ID of Genre *(Optional)*
my $program_id = 789; # int | Search on Program ID *(Optional)* `(Relation)`
my $broadcast_id = 789; # int | Search on Broadcast ID *(Optional)* `(Relation)`
my $limit = 789; # int | Results per page *(Optional)*
my $order_by = 'order_by_example'; # string | Field to order the results *(Optional)*
my $order_direction = 'order_direction_example'; # string | Direction of ordering *(Optional)*
my $_external_station_id = 789; # int | Query on a different (content providing) station *(Optional)*

eval { 
    my $result = $api_instance->list_genres(page => $page, parent_id => $parent_id, program_id => $program_id, broadcast_id => $broadcast_id, limit => $limit, order_by => $order_by, order_direction => $order_direction, _external_station_id => $_external_station_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GenreApi->list_genres: $@\n";
}

Parameters

Name Type Description Notes
page int Current page (Optional) [optional]
parent_id int Search on Parent ID of Genre (Optional) [optional]
program_id int Search on Program ID (Optional) `(Relation)` [optional]
broadcast_id int Search on Broadcast ID (Optional) `(Relation)` [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

GenreResults

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]