Skip to content

Latest commit

 

History

History
415 lines (329 loc) · 14.6 KB

SinkApi.md

File metadata and controls

415 lines (329 loc) · 14.6 KB
Raw

OmniCore.Api.SinkApi

All URIs are relative to https://api.korewireless.com

Method HTTP request Description
CreateSink POST /omnicore/subscriptions/{subscriptionId}/sinks
DeleteSink DELETE /omnicore/subscriptions/{subscriptionId}/sinks/{sinkId}
GetASink GET /omnicore/subscriptions/{subscriptionId}/sinks/{sinkId}
GetSinks GET /omnicore/subscriptions/{subscriptionId}/sinks Get All Sinks

CreateSink

Sink CreateSink (string subscriptionId, Sink sink = null)

Create a Sink

Example

using System.Collections.Generic;
using System.Diagnostics;
using OmniCore.Api;
using OmniCore.Client;
using OmniCore.Model;

namespace Example
{
    public class CreateSinkExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.korewireless.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new SinkApi(config);
            var subscriptionId = "subscriptionId_example";  // string | Subscription ID
            var sink = new Sink(); // Sink |  (optional) 

            try
            {
                Sink result = apiInstance.CreateSink(subscriptionId, sink);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SinkApi.CreateSink: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateSinkWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<Sink> response = apiInstance.CreateSinkWithHttpInfo(subscriptionId, sink);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SinkApi.CreateSinkWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
subscriptionId string Subscription ID
sink Sink [optional]

Return type

Sink

Authorization

apiKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
404 Not Found * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
500 Internal Server Error * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSink

Object DeleteSink (string subscriptionId, string sinkId)

Delete a Sink

Example

using System.Collections.Generic;
using System.Diagnostics;
using OmniCore.Api;
using OmniCore.Client;
using OmniCore.Model;

namespace Example
{
    public class DeleteSinkExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.korewireless.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new SinkApi(config);
            var subscriptionId = "subscriptionId_example";  // string | Subscription ID
            var sinkId = "sinkId_example";  // string | Sink ID

            try
            {
                Object result = apiInstance.DeleteSink(subscriptionId, sinkId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SinkApi.DeleteSink: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteSinkWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<Object> response = apiInstance.DeleteSinkWithHttpInfo(subscriptionId, sinkId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SinkApi.DeleteSinkWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
subscriptionId string Subscription ID
sinkId string Sink ID

Return type

Object

Authorization

apiKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
404 Not Found * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
500 Internal Server Error * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetASink

Sink GetASink (string subscriptionId, string sinkId)

Get A Sink

Example

using System.Collections.Generic;
using System.Diagnostics;
using OmniCore.Api;
using OmniCore.Client;
using OmniCore.Model;

namespace Example
{
    public class GetASinkExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.korewireless.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new SinkApi(config);
            var subscriptionId = "subscriptionId_example";  // string | Subscription ID
            var sinkId = "sinkId_example";  // string | Sink ID

            try
            {
                Sink result = apiInstance.GetASink(subscriptionId, sinkId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SinkApi.GetASink: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetASinkWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<Sink> response = apiInstance.GetASinkWithHttpInfo(subscriptionId, sinkId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SinkApi.GetASinkWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
subscriptionId string Subscription ID
sinkId string Sink ID

Return type

Sink

Authorization

apiKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
404 Not Found * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
500 Internal Server Error * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSinks

ListSinks GetSinks (string subscriptionId)

Get All Sinks

Get Sinks

Example

using System.Collections.Generic;
using System.Diagnostics;
using OmniCore.Api;
using OmniCore.Client;
using OmniCore.Model;

namespace Example
{
    public class GetSinksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.korewireless.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new SinkApi(config);
            var subscriptionId = "subscriptionId_example";  // string | Subscription ID

            try
            {
                // Get All Sinks
                ListSinks result = apiInstance.GetSinks(subscriptionId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SinkApi.GetSinks: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetSinksWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get All Sinks
    ApiResponse<ListSinks> response = apiInstance.GetSinksWithHttpInfo(subscriptionId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SinkApi.GetSinksWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
subscriptionId string Subscription ID

Return type

ListSinks

Authorization

apiKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
404 Not Found * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -
500 Internal Server Error * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Credentials -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]