All URIs are relative to https://radiomanager.io/api/v2
| Method | HTTP request | Description |
|---|---|---|
| CreateCampaign | Post /campaigns | Create campaign. |
| DeleteCampaignById | Delete /campaigns/{id} | Delete campaign by id |
| GetCampaignById | Get /campaigns/{id} | Get campaign by id |
| ListCampaigns | Get /campaigns | Get all campaigns. |
| UpdateCampaignByID | Patch /campaigns/{id} | Update campaign by id |
PostSuccess CreateCampaign(ctx, data) Create campaign.
Create campaign.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| data | CampaignDataInput | Data (Required) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Success DeleteCampaignById(ctx, id) Delete campaign by id
Delete campaign by id
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| id | int64 | ID of Campaign (Required) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CampaignResult GetCampaignById(ctx, id, optional) Get campaign by id
Get campaign by id
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| id | int64 | ID of Campaign (Required) | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | int64 | ID of Campaign (Required) | |
| externalStationId | int64 | Query on a different (content providing) station (Optional) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CampaignResults ListCampaigns(ctx, optional) Get all campaigns.
List all campaigns.
| 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 are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int64 | Current page (Optional) | |
| itemId | int64 | Search on Item ID (Optional) `(Relation)` | |
| modelTypeId | int64 | Search on ModelType 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) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Success UpdateCampaignByID(ctx, id, optional) Update campaign by id
Update campaign by id
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| id | int64 | ID of Campaign (Required) | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | int64 | ID of Campaign (Required) | |
| data | CampaignDataInput | Data (Optional) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]