Skip to content

Latest commit

 

History

History
130 lines (90 loc) · 3.91 KB

GroupApi.md

File metadata and controls

130 lines (90 loc) · 3.91 KB
Raw

radiomanager.GroupApi

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

Method HTTP request Description
getGroupById GET /groups/{id} Get group by id
listGroups GET /groups Get all groups.

getGroupById

GroupResult getGroupById(id, opts)

Get group by id

Get group 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.GroupApi();
let id = 789; // Number | id of Group
let opts = {
  'externalStationId': 789 // Number | Query on a different (content providing) station *(Optional)*
};
apiInstance.getGroupById(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 Group
externalStationId Number Query on a different (content providing) station (Optional) [optional]

Return type

GroupResult

Authorization

API-Key

HTTP request headers

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

listGroups

InlineResponse2007 listGroups(opts)

Get all groups.

List all groups.

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.GroupApi();
let opts = {
  'broadcastId': 789, // Number | Search on Broadcast ID *(Optional)* `(Relation)`
  'programId': 789, // Number | Search on Program ID *(Optional)* `(Relation)`
  'userId': 789, // Number | Search on User ID *(Optional)* `(Relation)`
  '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.listGroups(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]
programId Number Search on Program ID (Optional) `(Relation)` [optional]
userId Number Search on User ID (Optional) `(Relation)` [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

InlineResponse2007

Authorization

API-Key

HTTP request headers

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