Skip to content

Latest commit

 

History

History
291 lines (206 loc) · 9.12 KB

PresenterApi.md

File metadata and controls

291 lines (206 loc) · 9.12 KB

RadioManagerClient::PresenterApi

Load the API package

use RadioManagerClient::Object::PresenterApi;

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

Method HTTP request Description
create_presenter POST /presenters Create presenter.
delete_presenter_by_id DELETE /presenters/{id} Delete presenter by id
get_presenter_by_id GET /presenters/{id} Get presenter by id
list_presenters GET /presenters Get all presenters.
update_presenter_by_id PATCH /presenters/{id} Update presenter by id

create_presenter

PostSuccess create_presenter(data => $data)

Create presenter.

Create presenter.

Example

use Data::Dumper;
use RadioManagerClient::PresenterApi;
my $api_instance = RadioManagerClient::PresenterApi->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 $data = RadioManagerClient::Object::PresenterDataInput->new(); # PresenterDataInput | Data **(Required)**

eval { 
    my $result = $api_instance->create_presenter(data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PresenterApi->create_presenter: $@\n";
}

Parameters

Name Type Description Notes
data PresenterDataInput Data (Required)

Return type

PostSuccess

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]

delete_presenter_by_id

Success delete_presenter_by_id(id => $id)

Delete presenter by id

Delete presenter by id

Example

use Data::Dumper;
use RadioManagerClient::PresenterApi;
my $api_instance = RadioManagerClient::PresenterApi->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 presenter

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

Parameters

Name Type Description Notes
id int id of presenter

Return type

Success

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]

get_presenter_by_id

PresenterResult get_presenter_by_id(id => $id, _external_station_id => $_external_station_id)

Get presenter by id

Get presenter by id

Example

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

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

Parameters

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

Return type

PresenterResult

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_presenters

PresenterResults list_presenters(page => $page, program_id => $program_id, broadcast_id => $broadcast_id, model_type_id => $model_type_id, limit => $limit, order_by => $order_by, order_direction => $order_direction, _external_station_id => $_external_station_id)

Get all presenters.

List all presenters.

Example

use Data::Dumper;
use RadioManagerClient::PresenterApi;
my $api_instance = RadioManagerClient::PresenterApi->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 $program_id = 789; # int | Search on Program ID *(Optional)* `(Relation)`
my $broadcast_id = 789; # int | Search on Broadcast ID *(Optional)* `(Relation)`
my $model_type_id = 789; # int | Search on ModelType ID (Optional)
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_presenters(page => $page, program_id => $program_id, broadcast_id => $broadcast_id, model_type_id => $model_type_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 PresenterApi->list_presenters: $@\n";
}

Parameters

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

PresenterResults

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]

update_presenter_by_id

Success update_presenter_by_id(id => $id, data => $data)

Update presenter by id

Update presenter by id

Example

use Data::Dumper;
use RadioManagerClient::PresenterApi;
my $api_instance = RadioManagerClient::PresenterApi->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 Presenter
my $data = RadioManagerClient::Object::PresenterDataInput->new(); # PresenterDataInput | Data *(Optional)*

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

Parameters

Name Type Description Notes
id int id of Presenter
data PresenterDataInput Data (Optional) [optional]

Return type

Success

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]