Skip to content

Latest commit

 

History

History
228 lines (154 loc) · 6.48 KB

BlockApi.md

File metadata and controls

228 lines (154 loc) · 6.48 KB

radiomanager.BlockApi

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

Method HTTP request Description
getBlockById GET /blocks/{id} Get block by id
getCurrentBlock GET /blocks/current Get current Block
getNextBlock GET /blocks/next Get upcoming Block
listBlocks GET /blocks Get a list of all blocks currently in your station.

getBlockById

BlockResult getBlockById(id, opts)

Get block by id

Get block 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.BlockApi();
let id = 789; // Number | ID of Block **(Required)**
let opts = {
  'externalStationId': 789 // Number | Query on a different (content providing) station *(Optional)*
};
apiInstance.getBlockById(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 Block (Required)
externalStationId Number Query on a different (content providing) station (Optional) [optional]

Return type

BlockResult

Authorization

API-Key

HTTP request headers

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

getCurrentBlock

BlockResult getCurrentBlock()

Get current Block

Get currently playing Block

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.BlockApi();
apiInstance.getCurrentBlock().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

BlockResult

Authorization

API-Key

HTTP request headers

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

getNextBlock

BlockResult getNextBlock()

Get upcoming Block

Get currently upcoming Block

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.BlockApi();
apiInstance.getNextBlock().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

BlockResult

Authorization

API-Key

HTTP request headers

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

listBlocks

InlineResponse200 listBlocks(opts)

Get a list of all blocks currently in your station.

Get a list of all blocks currently in your station. This feature supports pagination and will give a maximum of 50 blocks back.

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.BlockApi();
let opts = {
  'broadcastId': 789, // Number | Search on Broadcast ID *(Optional)* `(Relation)`
  'itemId': 789, // Number | Search on Item ID *(Optional)* `(Relation)`
  'programId': 789, // Number | Search on Program ID *(Optional)* `(Relation)`
  'startMin': new Date("2013-10-20T19:20:30+01:00"), // Date | Minimum start date *(Optional)*
  'startMax': new Date("2013-10-20T19:20:30+01:00"), // Date | Maximum start date *(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.listBlocks(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]
itemId Number Search on Item ID (Optional) `(Relation)` [optional]
programId Number Search on Program ID (Optional) `(Relation)` [optional]
startMin Date Minimum start date (Optional) [optional]
startMax Date Maximum start date (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

InlineResponse200

Authorization

API-Key

HTTP request headers

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