Skip to content

Latest commit

 

History

History
141 lines (91 loc) · 4.56 KB

BlockApi.md

File metadata and controls

141 lines (91 loc) · 4.56 KB

\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(ctx, id, optional) Get block by id

Get block by id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int64 ID of Block (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 Block (Required)
externalStationId int64 Query on a different (content providing) station (Optional)

Return type

BlockResult

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]

GetCurrentBlock

BlockResult GetCurrentBlock(ctx, ) Get current Block

Get current Block

Required Parameters

This endpoint does not need any parameter.

Return type

BlockResult

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]

GetNextBlock

BlockResult GetNextBlock(ctx, ) Get upcoming Block

Get upcoming Block

Required Parameters

This endpoint does not need any parameter.

Return type

BlockResult

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]

ListBlocks

BlockResults ListBlocks(ctx, optional) 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.

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]
broadcastId int64 Search on Broadcast ID (Optional) `(Relation)`
itemId int64 Search on Item ID (Optional) `(Relation)`
programId int64 Search on Program 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

BlockResults

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]