Org.OpenAPITools.Api.RoleSettingsApi

All URIs are relative to https://api.teke.li/api/v1/obs

Method	HTTP request	Description
GetroleSettings	GET /role_settings	Retrieves one or more role_settings
GetroleSettingsItem	GET /role_settings/{role-settingsId}	Retrieves a role-settings document
PatchroleSettingsItem	PATCH /role_settings/{role-settingsId}	Updates a role-settings document
PostroleSettings	POST /role_settings	Stores one or more role_settings.
PutroleSettingsItem	PUT /role_settings/{role-settingsId}	Replaces a role-settings document

GetroleSettings

InlineResponse20010 GetroleSettings (string where = null, string sort = null, int? page = null, int? maxResults = null)

Retrieves one or more role_settings

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class GetroleSettingsExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            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 RoleSettingsApi(Configuration.Default);
            var where = where_example;  // string | the filters query parameter (ex.: {\"number\": 10}) (optional) 
            var sort = sort_example;  // string | the sort query parameter (ex.: \"city,-lastname\") (optional) 
            var page = 1;  // int? | the pages query parameter (optional) 
            var maxResults = 25;  // int? | the max results query parameter (optional) 

            try
            {
                // Retrieves one or more role_settings
                InlineResponse20010 result = apiInstance.GetroleSettings(where, sort, page, maxResults);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RoleSettingsApi.GetroleSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
where	string	the filters query parameter (ex.: {"number": 10})	[optional]
sort	string	the sort query parameter (ex.: "city,-lastname")	[optional]
page	int?	the pages query parameter	[optional]
maxResults	int?	the max results query parameter	[optional]

Return type

InlineResponse20010

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	An array of role_settings	-
0	An error message	-

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

GetroleSettingsItem

RoleSettings GetroleSettingsItem (string roleSettingsId)

Retrieves a role-settings document

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class GetroleSettingsItemExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            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 RoleSettingsApi(Configuration.Default);
            var roleSettingsId = roleSettingsId_example;  // string | 

            try
            {
                // Retrieves a role-settings document
                RoleSettings result = apiInstance.GetroleSettingsItem(roleSettingsId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RoleSettingsApi.GetroleSettingsItem: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
roleSettingsId	string

Return type

RoleSettings

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	role-settings document fetched successfully	-
0	An error message	-

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

PatchroleSettingsItem

void PatchroleSettingsItem (string roleSettingsId, string ifMatch, RoleSettings roleSettings)

Updates a role-settings document

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class PatchroleSettingsItemExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            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 RoleSettingsApi(Configuration.Default);
            var roleSettingsId = roleSettingsId_example;  // string | 
            var ifMatch = ifMatch_example;  // string | Current value of the _etag field
            var roleSettings = new RoleSettings(); // RoleSettings | A role-settings or list of role-settings documents

            try
            {
                // Updates a role-settings document
                apiInstance.PatchroleSettingsItem(roleSettingsId, ifMatch, roleSettings);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RoleSettingsApi.PatchroleSettingsItem: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
roleSettingsId	string
ifMatch	string	Current value of the _etag field
roleSettings	RoleSettings	A role-settings or list of role-settings documents

Return type

void (empty response body)

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	role-settings document updated successfully	-
0	An error message	-

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

PostroleSettings

void PostroleSettings (RoleSettings roleSettings)

Stores one or more role_settings.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class PostroleSettingsExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            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 RoleSettingsApi(Configuration.Default);
            var roleSettings = new RoleSettings(); // RoleSettings | A role-settings or list of role-settings documents

            try
            {
                // Stores one or more role_settings.
                apiInstance.PostroleSettings(roleSettings);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RoleSettingsApi.PostroleSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
roleSettings	RoleSettings	A role-settings or list of role-settings documents

Return type

void (empty response body)

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	operation has been successful	-
0	An error message	-

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

PutroleSettingsItem

void PutroleSettingsItem (string roleSettingsId, string ifMatch, RoleSettings roleSettings)

Replaces a role-settings document

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class PutroleSettingsItemExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            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 RoleSettingsApi(Configuration.Default);
            var roleSettingsId = roleSettingsId_example;  // string | 
            var ifMatch = ifMatch_example;  // string | Current value of the _etag field
            var roleSettings = new RoleSettings(); // RoleSettings | A role-settings or list of role-settings documents

            try
            {
                // Replaces a role-settings document
                apiInstance.PutroleSettingsItem(roleSettingsId, ifMatch, roleSettings);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RoleSettingsApi.PutroleSettingsItem: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
roleSettingsId	string
ifMatch	string	Current value of the _etag field
roleSettings	RoleSettings	A role-settings or list of role-settings documents

Return type

void (empty response body)

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	role-settings document replaced successfully	-
0	An error message	-

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

Files

RoleSettingsApi.md

Latest commit

History

RoleSettingsApi.md

File metadata and controls

Org.OpenAPITools.Api.RoleSettingsApi

GetroleSettings

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetroleSettingsItem

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PatchroleSettingsItem

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PostroleSettings

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PutroleSettingsItem

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details