Skip to content

Latest commit

 

History

History
412 lines (269 loc) · 13.5 KB

BroadcastApi.md

File metadata and controls

412 lines (269 loc) · 13.5 KB
Raw

\BroadcastApi

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

Method HTTP request Description
CreateBroadcast Post /broadcasts Create broadcast.
DeleteBroadcastById Delete /broadcasts/{id} Delete broadcast by id
GetBroadcastById Get /broadcasts/{id} Get broadcast by id
GetCurrentBroadcast Get /broadcasts/current Get current Broadcast
GetDailyEPG Get /broadcasts/epg/daily Get daily EPG
GetEPGByDate Get /broadcasts/epg Get EPG by date
GetNextBroadcast Get /broadcasts/next Get next Broadcast
GetWeeklyEPG Get /broadcasts/epg/weekly Get weekly EPG
ListBroadcasts Get /broadcasts Get all broadcasts.
PrintBroadcastById Get /broadcasts/print/{id} Print broadcast by id with template
UpdateBroadcastByID Patch /broadcasts/{id} Update broadcast by id

CreateBroadcast

PostSuccess CreateBroadcast(ctx, data) Create broadcast.

Create broadcast.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
data BroadcastDataInput 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]

DeleteBroadcastById

Success DeleteBroadcastById(ctx, id) Delete broadcast by id

Delete broadcast by id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int64 ID of Broadcast (Required)

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]

GetBroadcastById

BroadcastResult GetBroadcastById(ctx, id, optional) Get broadcast by id

Get broadcast by id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int64 ID of Broadcast (Required)
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id int64 ID of Broadcast (Required)
externalStationId int64 Query on a different (content providing) station (Optional)

Return type

BroadcastResult

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]

GetCurrentBroadcast

BroadcastResult GetCurrentBroadcast(ctx, optional) Get current Broadcast

Get current Broadcast

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
withunpublished bool Show Unpublished (Optional)

Return type

BroadcastResult

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]

GetDailyEPG

EpgResults GetDailyEPG(ctx, optional) Get daily EPG

Get current Broadcast

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
date time.Time Date (Optional)
withunpublished bool Show Unpublished (Optional)

Return type

EpgResults

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]

GetEPGByDate

EpgResults GetEPGByDate(ctx, optional) Get EPG by date

Get EPG by date

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
date time.Time Date (Optional)
withunpublished bool Show Unpublished (Optional)

Return type

EpgResults

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]

GetNextBroadcast

BroadcastResult GetNextBroadcast(ctx, optional) Get next Broadcast

Get next Broadcast

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
withunpublished bool Show Unpublished (Optional)

Return type

BroadcastResult

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]

GetWeeklyEPG

EpgResults GetWeeklyEPG(ctx, optional) Get weekly EPG

Get weekly EPG

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
date string Date (Optional)
withunpublished bool Show Unpublished (Optional)

Return type

EpgResults

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]

ListBroadcasts

BroadcastResults ListBroadcasts(ctx, optional) Get all broadcasts.

List all broadcasts.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
page int64 Current page (Optional) [default to 1]
programId int64 Search on Program ID (Optional) `(Relation)`
blockId int64 Search on Block ID (Optional) `(Relation)`
modelTypeId int64 Search on ModelType ID (Optional) `(Relation)`
tagId int64 Search on Tag ID (Optional) `(Relation)`
presenterId int64 Search on Presenter ID (Optional) `(Relation)`
genreId int64 Search on Genre ID (Optional) `(Relation)`
itemId int64 Search on Item ID (Optional) `(Relation)`
startMin time.Time Minimum start date (Optional)
startMax time.Time Maximum start date (Optional)
limit int64 Results per page (Optional)
orderBy string Field to order the results (Optional)
orderDirection string Direction of ordering (Optional)
externalStationId int64 Query on a different (content providing) station (Optional)

Return type

BroadcastResults

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]

PrintBroadcastById

string PrintBroadcastById(ctx, id, optional) Print broadcast by id with template

Print broadcast by id with template

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int64 ID of Broadcast (Required)
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id int64 ID of Broadcast (Required)
templateId int64 Search on template ID (Optional)

Return type

string

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]

UpdateBroadcastByID

Success UpdateBroadcastByID(ctx, id, optional) Update broadcast by id

Update broadcast by id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int64 ID of Broadcast (Required)
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id int64 ID of Broadcast (Required)
data BroadcastDataInput Data (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]