Skip to content

Latest commit

 

History

History
297 lines (203 loc) · 8.89 KB

ProgramApi.md

File metadata and controls

297 lines (203 loc) · 8.89 KB

radiomanager.ProgramApi

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

Method HTTP request Description
createProgram POST /programs Create program.
deleteProgramById DELETE /programs/{id} Delete program by id
getProgramById GET /programs/{id} Get program by id
listPrograms GET /programs Get all programs.
updateProgramByID PATCH /programs/{id} Update program by id

createProgram

InlineResponse2002 createProgram(programDataInput)

Create program.

Create program.

Example

import radiomanager from 'radiomanager';
let defaultClient = radiomanager.ApiClient.instance;
// Configure API key authorization: API-Key
let API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

let apiInstance = new radiomanager.ProgramApi();
let programDataInput = new radiomanager.ProgramDataInput(); // ProgramDataInput | Data **(Required)**
apiInstance.createProgram(programDataInput).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
programDataInput ProgramDataInput Data (Required)

Return type

InlineResponse2002

Authorization

API-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteProgramById

InlineResponse202 deleteProgramById(id)

Delete program by id

Delete program by id

Example

import radiomanager from 'radiomanager';
let defaultClient = radiomanager.ApiClient.instance;
// Configure API key authorization: API-Key
let API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

let apiInstance = new radiomanager.ProgramApi();
let id = 789; // Number | ID of program **(Required)**
apiInstance.deleteProgramById(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number ID of program (Required)

Return type

InlineResponse202

Authorization

API-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getProgramById

ProgramResult getProgramById(id, opts)

Get program by id

Get program by id

Example

import radiomanager from 'radiomanager';
let defaultClient = radiomanager.ApiClient.instance;
// Configure API key authorization: API-Key
let API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

let apiInstance = new radiomanager.ProgramApi();
let id = 789; // Number | ID of Program **(Required)**
let opts = {
  'externalStationId': 789 // Number | Query on a different (content providing) station *(Optional)*
};
apiInstance.getProgramById(id, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number ID of Program (Required)
externalStationId Number Query on a different (content providing) station (Optional) [optional]

Return type

ProgramResult

Authorization

API-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listPrograms

InlineResponse20011 listPrograms(opts)

Get all programs.

List all programs.

Example

import radiomanager from 'radiomanager';
let defaultClient = radiomanager.ApiClient.instance;
// Configure API key authorization: API-Key
let API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

let apiInstance = new radiomanager.ProgramApi();
let opts = {
  'broadcastId': 789, // Number | Search on Broadcast ID *(Optional)* `(Relation)`
  'modelTypeId': 789, // Number | Search on ModelType ID *(Optional)* `(Relation)`
  'tagId': 789, // Number | Search on Tag ID *(Optional)* `(Relation)`
  'presenterId': 789, // Number | Search on Presenter ID *(Optional)* `(Relation)`
  'genreId': 789, // Number | Search on Genre ID *(Optional)*
  'groupId': 789, // Number | Search on Group ID *(Optional)*
  'blockId': 789, // Number | Search on Block ID *(Optional)* `(Relation)`
  'itemId': 789, // Number | Search on Item ID *(Optional)* `(Relation)`
  'disabled': 56, // Number | Search on Disabled status *(Optional)*
  'page': 1, // Number | Current page *(Optional)*
  'limit': 789, // Number | Results per page *(Optional)*
  'orderBy': "orderBy_example", // String | Field to order the results *(Optional)*
  'orderDirection': "orderDirection_example", // String | Direction of ordering *(Optional)*
  'externalStationId': 789 // Number | Query on a different (content providing) station *(Optional)*
};
apiInstance.listPrograms(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
broadcastId Number Search on Broadcast ID (Optional) `(Relation)` [optional]
modelTypeId Number Search on ModelType ID (Optional) `(Relation)` [optional]
tagId Number Search on Tag ID (Optional) `(Relation)` [optional]
presenterId Number Search on Presenter ID (Optional) `(Relation)` [optional]
genreId Number Search on Genre ID (Optional) [optional]
groupId Number Search on Group ID (Optional) [optional]
blockId Number Search on Block ID (Optional) `(Relation)` [optional]
itemId Number Search on Item ID (Optional) `(Relation)` [optional]
disabled Number Search on Disabled status (Optional) [optional]
page Number Current page (Optional) [optional] [default to 1]
limit Number Results per page (Optional) [optional]
orderBy String Field to order the results (Optional) [optional]
orderDirection String Direction of ordering (Optional) [optional]
externalStationId Number Query on a different (content providing) station (Optional) [optional]

Return type

InlineResponse20011

Authorization

API-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateProgramByID

InlineResponse202 updateProgramByID(id, programDataInput)

Update program by id

Update program by id

Example

import radiomanager from 'radiomanager';
let defaultClient = radiomanager.ApiClient.instance;
// Configure API key authorization: API-Key
let API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

let apiInstance = new radiomanager.ProgramApi();
let id = 789; // Number | ID of Program **(Required)**
let programDataInput = new radiomanager.ProgramDataInput(); // ProgramDataInput | Data *(Optional)*
apiInstance.updateProgramByID(id, programDataInput).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number ID of Program (Required)
programDataInput ProgramDataInput Data (Optional)

Return type

InlineResponse202

Authorization

API-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json