Skip to content

Latest commit

 

History

History
371 lines (287 loc) · 12.2 KB

ProgramApi.md

File metadata and controls

371 lines (287 loc) · 12.2 KB
Raw

RadioManager.Api.ProgramApi

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

Method HTTP request Description
CreateProgram POST /programs Create program.
DeleteProgramById DELETE /programs/{id} Delete program by id
GetProgramById GET /programs/{id} Get program by id
ListPrograms GET /programs Get all programs.
UpdateProgramByID PATCH /programs/{id} Update program by id

CreateProgram

PostSuccess CreateProgram (ProgramDataInput data)

Create program.

Create program.

Example

using System;
using System.Diagnostics;
using RadioManager.Api;
using RadioManager.Client;
using RadioManager.Model;

namespace Example
{
    public class CreateProgramExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new ProgramApi();
            var data = new ProgramDataInput(); // ProgramDataInput | Data **(Required)**

            try
            {
                // Create program.
                PostSuccess result = apiInstance.CreateProgram(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProgramApi.CreateProgram: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
data ProgramDataInput 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]

DeleteProgramById

Success DeleteProgramById (long? id)

Delete program by id

Delete program by id

Example

using System;
using System.Diagnostics;
using RadioManager.Api;
using RadioManager.Client;
using RadioManager.Model;

namespace Example
{
    public class DeleteProgramByIdExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new ProgramApi();
            var id = 789;  // long? | ID of program **(Required)**

            try
            {
                // Delete program by id
                Success result = apiInstance.DeleteProgramById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProgramApi.DeleteProgramById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id long? ID of program (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]

GetProgramById

ProgramResult GetProgramById (long? id, long? externalStationId = null)

Get program by id

Get program by id

Example

using System;
using System.Diagnostics;
using RadioManager.Api;
using RadioManager.Client;
using RadioManager.Model;

namespace Example
{
    public class GetProgramByIdExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new ProgramApi();
            var id = 789;  // long? | ID of Program **(Required)**
            var externalStationId = 789;  // long? | Query on a different (content providing) station *(Optional)* (optional) 

            try
            {
                // Get program by id
                ProgramResult result = apiInstance.GetProgramById(id, externalStationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProgramApi.GetProgramById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id long? ID of Program (Required)
externalStationId long? Query on a different (content providing) station (Optional) [optional]

Return type

ProgramResult

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]

ListPrograms

ProgramResults ListPrograms (long? page = null, long? broadcastId = null, long? modelTypeId = null, long? tagId = null, long? presenterId = null, long? genreId = null, long? blockId = null, long? itemId = null, int? disabled = null, long? limit = null, string orderBy = null, string orderDirection = null, long? externalStationId = null)

Get all programs.

List all programs.

Example

using System;
using System.Diagnostics;
using RadioManager.Api;
using RadioManager.Client;
using RadioManager.Model;

namespace Example
{
    public class ListProgramsExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new ProgramApi();
            var page = 789;  // long? | Current page *(Optional)* (optional) 
            var broadcastId = 789;  // long? | Search on Broadcast ID *(Optional)* `(Relation)` (optional) 
            var modelTypeId = 789;  // long? | Search on ModelType ID *(Optional)* `(Relation)` (optional) 
            var tagId = 789;  // long? | Search on Tag ID *(Optional)* `(Relation)` (optional) 
            var presenterId = 789;  // long? | Search on Presenter ID *(Optional)* `(Relation)` (optional) 
            var genreId = 789;  // long? | Search on Genre ID *(Optional)* (optional) 
            var blockId = 789;  // long? | Search on Block ID *(Optional)* `(Relation)` (optional) 
            var itemId = 789;  // long? | Search on Item ID *(Optional)* `(Relation)` (optional) 
            var disabled = 56;  // int? | Search on Disabled status *(Optional)* (optional) 
            var limit = 789;  // long? | Results per page *(Optional)* (optional) 
            var orderBy = orderBy_example;  // string | Field to order the results *(Optional)* (optional) 
            var orderDirection = orderDirection_example;  // string | Direction of ordering *(Optional)* (optional) 
            var externalStationId = 789;  // long? | Query on a different (content providing) station *(Optional)* (optional) 

            try
            {
                // Get all programs.
                ProgramResults result = apiInstance.ListPrograms(page, broadcastId, modelTypeId, tagId, presenterId, genreId, blockId, itemId, disabled, limit, orderBy, orderDirection, externalStationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProgramApi.ListPrograms: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
page long? Current page (Optional) [optional]
broadcastId long? Search on Broadcast ID (Optional) `(Relation)` [optional]
modelTypeId long? Search on ModelType ID (Optional) `(Relation)` [optional]
tagId long? Search on Tag ID (Optional) `(Relation)` [optional]
presenterId long? Search on Presenter ID (Optional) `(Relation)` [optional]
genreId long? Search on Genre ID (Optional) [optional]
blockId long? Search on Block ID (Optional) `(Relation)` [optional]
itemId long? Search on Item ID (Optional) `(Relation)` [optional]
disabled int? Search on Disabled status (Optional) [optional]
limit long? Results per page (Optional) [optional]
orderBy string Field to order the results (Optional) [optional]
orderDirection string Direction of ordering (Optional) [optional]
externalStationId long? Query on a different (content providing) station (Optional) [optional]

Return type

ProgramResults

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]

UpdateProgramByID

Success UpdateProgramByID (long? id, ProgramDataInput data = null)

Update program by id

Update program by id

Example

using System;
using System.Diagnostics;
using RadioManager.Api;
using RadioManager.Client;
using RadioManager.Model;

namespace Example
{
    public class UpdateProgramByIDExample
    {
        public void main()
        {
            // Configure API key authorization: API Key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");

            var apiInstance = new ProgramApi();
            var id = 789;  // long? | ID of Program **(Required)**
            var data = new ProgramDataInput(); // ProgramDataInput | Data *(Optional)* (optional) 

            try
            {
                // Update program by id
                Success result = apiInstance.UpdateProgramByID(id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProgramApi.UpdateProgramByID: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id long? ID of Program (Required)
data ProgramDataInput Data (Optional) [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]