Org.OpenAPITools.Api.OrganizationDetailsApi

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

Method	HTTP request	Description
GetorgDetails	GET /org_details	Retrieves one or more org_details
GetorganizationDetailsItem	GET /org_details/{organization-detailsId}	Retrieves a organization-details document
PatchorganizationDetailsItem	PATCH /org_details/{organization-detailsId}	Updates a organization-details document
PostorgDetails	POST /org_details	Stores one or more org_details.
PutorganizationDetailsItem	PUT /org_details/{organization-detailsId}	Replaces a organization-details document

GetorgDetails

InlineResponse2007 GetorgDetails (string where = null, string sort = null, int? page = null, int? maxResults = null)

Retrieves one or more org_details

Example

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

namespace Example
{
    public class GetorgDetailsExample
    {
        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 OrganizationDetailsApi(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 org_details
                InlineResponse2007 result = apiInstance.GetorgDetails(where, sort, page, maxResults);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrganizationDetailsApi.GetorgDetails: " + 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

InlineResponse2007

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 org_details	-
0	An error message	-

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

GetorganizationDetailsItem

OrganizationDetails GetorganizationDetailsItem (string organizationDetailsId)

Retrieves a organization-details 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 GetorganizationDetailsItemExample
    {
        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 OrganizationDetailsApi(Configuration.Default);
            var organizationDetailsId = organizationDetailsId_example;  // string | 

            try
            {
                // Retrieves a organization-details document
                OrganizationDetails result = apiInstance.GetorganizationDetailsItem(organizationDetailsId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrganizationDetailsApi.GetorganizationDetailsItem: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationDetailsId	string

Return type

OrganizationDetails

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	organization-details document fetched successfully	-
0	An error message	-

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

PatchorganizationDetailsItem

void PatchorganizationDetailsItem (string organizationDetailsId, string ifMatch, OrganizationDetails organizationDetails)

Updates a organization-details 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 PatchorganizationDetailsItemExample
    {
        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 OrganizationDetailsApi(Configuration.Default);
            var organizationDetailsId = organizationDetailsId_example;  // string | 
            var ifMatch = ifMatch_example;  // string | Current value of the _etag field
            var organizationDetails = new OrganizationDetails(); // OrganizationDetails | A organization-details or list of organization-details documents

            try
            {
                // Updates a organization-details document
                apiInstance.PatchorganizationDetailsItem(organizationDetailsId, ifMatch, organizationDetails);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrganizationDetailsApi.PatchorganizationDetailsItem: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
organizationDetailsId	string
ifMatch	string	Current value of the _etag field
organizationDetails	OrganizationDetails	A organization-details or list of organization-details 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	organization-details document updated successfully	-
0	An error message	-

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

PostorgDetails

void PostorgDetails (OrganizationDetails organizationDetails)

Stores one or more org_details.

Example

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

namespace Example
{
    public class PostorgDetailsExample
    {
        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 OrganizationDetailsApi(Configuration.Default);
            var organizationDetails = new OrganizationDetails(); // OrganizationDetails | A organization-details or list of organization-details documents

            try
            {
                // Stores one or more org_details.
                apiInstance.PostorgDetails(organizationDetails);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrganizationDetailsApi.PostorgDetails: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationDetails	OrganizationDetails	A organization-details or list of organization-details 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]

PutorganizationDetailsItem

void PutorganizationDetailsItem (string organizationDetailsId, string ifMatch, OrganizationDetails organizationDetails)

Replaces a organization-details 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 PutorganizationDetailsItemExample
    {
        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 OrganizationDetailsApi(Configuration.Default);
            var organizationDetailsId = organizationDetailsId_example;  // string | 
            var ifMatch = ifMatch_example;  // string | Current value of the _etag field
            var organizationDetails = new OrganizationDetails(); // OrganizationDetails | A organization-details or list of organization-details documents

            try
            {
                // Replaces a organization-details document
                apiInstance.PutorganizationDetailsItem(organizationDetailsId, ifMatch, organizationDetails);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrganizationDetailsApi.PutorganizationDetailsItem: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
organizationDetailsId	string
ifMatch	string	Current value of the _etag field
organizationDetails	OrganizationDetails	A organization-details or list of organization-details 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	organization-details document replaced successfully	-
0	An error message	-

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

Files

OrganizationDetailsApi.md

Latest commit

History

OrganizationDetailsApi.md

File metadata and controls

Org.OpenAPITools.Api.OrganizationDetailsApi

GetorgDetails

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetorganizationDetailsItem

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PatchorganizationDetailsItem

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PostorgDetails

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PutorganizationDetailsItem

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details