Skip to content

Latest commit

 

History

History
186 lines (121 loc) · 5.99 KB

TagApi.md

File metadata and controls

186 lines (121 loc) · 5.99 KB

\TagApi

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

Method HTTP request Description
CreateTag Post /tags Create tag.
DeleteTagById Delete /tags/{id} Delete tag by id
GetTagById Get /tags/{id} Get tags by id
ListTags Get /tags Get a list of all the tags currently in your station.
UpdateTagByID Patch /tags/{id} Update tag by id

CreateTag

PostSuccess CreateTag(ctx, data) Create tag.

Create tag.

Required Parameters

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

DeleteTagById

Success DeleteTagById(ctx, id) Delete tag by id

Delete tag by id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int64 ID of Tag (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]

GetTagById

TagResult GetTagById(ctx, id, optional) Get tags by id

Get tags by id

Required Parameters

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

Return type

TagResult

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]

ListTags

TagResults ListTags(ctx, optional) Get a list of all the tags currently in your station.

Get a list of all the tags currently in your station. This feature supports pagination and will give a maximum results of 50 tags 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)
programId int64 Search on Program ID (Optional) `(Relation)`
itemId int64 Search on Item ID (Optional) `(Relation)`
broadcastId int64 Search on Broadcast ID (Optional) `(Relation)`
contactId int64 Search on Contact ID (Optional) `(Relation)`
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

TagResults

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]

UpdateTagByID

Success UpdateTagByID(ctx, id, optional) Update tag by id

Update tag by id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int64 ID of Tag (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 Tag (Required)
data TagDataInput 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]