Skip to content

Latest commit

 

History

History
361 lines (277 loc) · 11 KB

StoryApi.md

File metadata and controls

361 lines (277 loc) · 11 KB

RadioManager.Api.StoryApi

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

Method HTTP request Description
CreateStory POST /stories Create story.
DeleteStoryById DELETE /stories/{id} Delete story by id
GetStoryById GET /stories/{id} Get story by id
ListStories GET /stories Get all stories.
UpdateStoryByID PATCH /stories/{id} Update story by id

CreateStory

PostSuccess CreateStory (StoryDataInput data)

Create story.

Create story.

Example

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

namespace Example
{
    public class CreateStoryExample
    {
        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 StoryApi();
            var data = new StoryDataInput(); // StoryDataInput | Data **(Required)**

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

Parameters

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

DeleteStoryById

Success DeleteStoryById (long? id)

Delete story by id

Delete story by id

Example

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

namespace Example
{
    public class DeleteStoryByIdExample
    {
        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 StoryApi();
            var id = 789;  // long? | ID of Story **(Required)**

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

Parameters

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

GetStoryById

StoryResult GetStoryById (long? id, long? externalStationId = null)

Get story by id

Get story by id

Example

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

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

            try
            {
                // Get story by id
                StoryResult result = apiInstance.GetStoryById(id, externalStationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoryApi.GetStoryById: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

StoryResult

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]

ListStories

StoryResults ListStories (long? page = null, long? itemId = null, long? modelTypeId = null, long? tagId = null, long? limit = null, string orderBy = null, string orderDirection = null, long? externalStationId = null)

Get all stories.

List all stories.

Example

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

namespace Example
{
    public class ListStoriesExample
    {
        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 StoryApi();
            var page = 789;  // long? | Current page *(Optional)* (optional)  (default to 1)
            var itemId = 789;  // long? | Search on Item 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 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 stories.
                StoryResults result = apiInstance.ListStories(page, itemId, modelTypeId, tagId, limit, orderBy, orderDirection, externalStationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoryApi.ListStories: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
page long? Current page (Optional) [optional] [default to 1]
itemId long? Search on Item ID (Optional) `(Relation)` [optional]
modelTypeId long? Search on ModelType ID (Optional) `(Relation)` [optional]
tagId long? Search on Tag ID (Optional) `(Relation)` [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

StoryResults

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]

UpdateStoryByID

Success UpdateStoryByID (long? id, StoryDataInput data = null)

Update story by id

Update story by id

Example

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

namespace Example
{
    public class UpdateStoryByIDExample
    {
        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 StoryApi();
            var id = 789;  // long? | ID of Story **(Required)**
            var data = new StoryDataInput(); // StoryDataInput | Data *(Optional)* (optional) 

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

Parameters

Name Type Description Notes
id long? ID of Story (Required)
data StoryDataInput 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]