Skip to content

Latest commit

 

History

History
166 lines (130 loc) · 6.4 KB

ModelTypeApi.md

File metadata and controls

166 lines (130 loc) · 6.4 KB

RadioManager.Api.ModelTypeApi

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

Method HTTP request Description
GetModelTypeById GET /model_types/{id} Get modelType by id
ListModelTypes GET /model_types Get all modelTypes.

GetModelTypeById

ModelTypeResult GetModelTypeById (long? id, long? externalStationId = null)

Get modelType by id

Get modelType by id

Example

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

namespace Example
{
    public class GetModelTypeByIdExample
    {
        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 ModelTypeApi();
            var id = 789;  // long? | ID of ModelType **(Required)**
            var externalStationId = 789;  // long? | Query on a different (content providing) station *(Optional)* (optional) 

            try
            {
                // Get modelType by id
                ModelTypeResult result = apiInstance.GetModelTypeById(id, externalStationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModelTypeApi.GetModelTypeById: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

ModelTypeResult

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]

ListModelTypes

ModelTypeResults ListModelTypes (long? page = null, long? programId = null, long? broadcastId = null, long? itemId = null, long? campaignId = null, long? presenterId = null, long? contactId = null, string model = null, long? limit = null, string orderBy = null, string orderDirection = null, long? externalStationId = null)

Get all modelTypes.

List all modelTypes.

Example

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

namespace Example
{
    public class ListModelTypesExample
    {
        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 ModelTypeApi();
            var page = 789;  // long? | Current page *(Optional)* (optional) 
            var programId = 789;  // long? | Search on Program ID *(Optional)* (optional) 
            var broadcastId = 789;  // long? | Search on Broadcast ID *(Optional)* (optional) 
            var itemId = 789;  // long? | Search on Item ID *(Optional)* (optional) 
            var campaignId = 789;  // long? | Search on Campaign ID *(Optional)* (optional) 
            var presenterId = 789;  // long? | Search on Presenter ID *(Optional)* (optional) 
            var contactId = 789;  // long? | Search on Contact ID *(Optional)* (optional) 
            var model = model_example;  // string | Search Modeltypes for certain Model *(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 modelTypes.
                ModelTypeResults result = apiInstance.ListModelTypes(page, programId, broadcastId, itemId, campaignId, presenterId, contactId, model, limit, orderBy, orderDirection, externalStationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModelTypeApi.ListModelTypes: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
page long? Current page (Optional) [optional]
programId long? Search on Program ID (Optional) [optional]
broadcastId long? Search on Broadcast ID (Optional) [optional]
itemId long? Search on Item ID (Optional) [optional]
campaignId long? Search on Campaign ID (Optional) [optional]
presenterId long? Search on Presenter ID (Optional) [optional]
contactId long? Search on Contact ID (Optional) [optional]
model string Search Modeltypes for certain Model (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

ModelTypeResults

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]