Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found
Select Git revision

Target

Select target project
  • coscine/backend/libraries/apiclient
1 result
Select Git revision
Show changes
Showing
with 1082 additions and 0 deletions
# Coscine.ApiClient.Core.Model.GitlabProjectDtoIEnumerableResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**List<GitlabProjectDto>**](GitlabProjectDto.md) | | [optional]
**IsSuccess** | **bool** | | [optional] [readonly]
**StatusCode** | **int?** | | [optional]
**TraceId** | **string** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.GitlabProjectDtoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**GitlabProjectDto**](GitlabProjectDto.md) | | [optional]
**IsSuccess** | **bool** | | [optional] [readonly]
**StatusCode** | **int?** | | [optional]
**TraceId** | **string** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.GitlabResourceTypeOptionsForCreationDto
Represents the data transfer object (DTO) for creating GitLab resource type options.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Branch** | **string** | The branch associated with the GitLab resource. |
**AccessToken** | **string** | The access token for authentication with GitLab. |
**RepoUrl** | **string** | The repository URL for the GitLab resource. |
**ProjectId** | **int** | The project ID associated with the GitLab resource. |
**TosAccepted** | **bool** | Indicates whether the terms of service for the GitLab resource are accepted. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.GitlabResourceTypeOptionsForUpdateDto
Represents the data transfer object (DTO) for updating GitLab resource type options.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Branch** | **string** | The branch associated with the GitLab resource. |
**AccessToken** | **string** | The access token for authentication with GitLab. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Api.HandleApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2HandlesOptions**](HandleApi.md#apiv2handlesoptions) | **OPTIONS** /api/v2/handles | Responds with the HTTP methods allowed for the endpoint. |
| [**GetHandle**](HandleApi.md#gethandle) | **GET** /api/v2/handles/{prefix}/{suffix} | Retrieves all values of a handle by its PID. |
| [**UpdateHandle**](HandleApi.md#updatehandle) | **PUT** /api/v2/handles/{prefix}/{suffix} | Updates a handle. |
<a id="apiv2handlesoptions"></a>
# **ApiV2HandlesOptions**
> void ApiV2HandlesOptions ()
Responds with the HTTP methods allowed for the endpoint.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class ApiV2HandlesOptionsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HandleApi(config);
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2HandlesOptions();
}
catch (ApiException e)
{
Debug.Print("Exception when calling HandleApi.ApiV2HandlesOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2HandlesOptionsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2HandlesOptionsWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling HandleApi.ApiV2HandlesOptionsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a id="gethandle"></a>
# **GetHandle**
> HandleDtoResponse GetHandle (string prefix, string suffix)
Retrieves all values of a handle by its PID.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetHandleExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HandleApi(config);
var prefix = "prefix_example"; // string | The prefix of the PID
var suffix = "suffix_example"; // string | The suffix of the PID
try
{
// Retrieves all values of a handle by its PID.
HandleDtoResponse result = apiInstance.GetHandle(prefix, suffix);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HandleApi.GetHandle: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetHandleWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves all values of a handle by its PID.
ApiResponse<HandleDtoResponse> response = apiInstance.GetHandleWithHttpInfo(prefix, suffix);
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 HandleApi.GetHandleWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **prefix** | **string** | The prefix of the PID | |
| **suffix** | **string** | The suffix of the PID | |
### Return type
[**HandleDtoResponse**](HandleDtoResponse.md)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the handles. | - |
| **403** | User is missing authorization requirements. This endpoint is only available to Coscine Admin users. | - |
| **404** | Provided input refers to entries that do not exist or have been deleted. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a id="updatehandle"></a>
# **UpdateHandle**
> void UpdateHandle (string prefix, string suffix, HandleForUpdateDto? handleForUpdateDto = null)
Updates a handle.
<p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class UpdateHandleExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HandleApi(config);
var prefix = "prefix_example"; // string | The prefix of the PID
var suffix = "suffix_example"; // string | The suffix of the PID
var handleForUpdateDto = new HandleForUpdateDto?(); // HandleForUpdateDto? | The handle for updating. (optional)
try
{
// Updates a handle.
apiInstance.UpdateHandle(prefix, suffix, handleForUpdateDto);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HandleApi.UpdateHandle: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the UpdateHandleWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Updates a handle.
apiInstance.UpdateHandleWithHttpInfo(prefix, suffix, handleForUpdateDto);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HandleApi.UpdateHandleWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **prefix** | **string** | The prefix of the PID | |
| **suffix** | **string** | The suffix of the PID | |
| **handleForUpdateDto** | [**HandleForUpdateDto?**](HandleForUpdateDto?.md) | The handle for updating. | [optional] |
### Return type
void (empty response body)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: application/json, text/json, application/*+json
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | Handle updated. | - |
| **403** | User is missing authorization requirements. This endpoint is only available to Coscine Admin users. | - |
| **404** | Provided input refers to entries that do not exist or have been deleted. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.HandleDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Pid** | [**PidDto**](PidDto.md) | | [optional]
**Values** | [**List&lt;HandleValueDto&gt;**](HandleValueDto.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.HandleDtoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**HandleDto**](HandleDto.md) | | [optional]
**IsSuccess** | **bool** | | [optional] [readonly]
**StatusCode** | **int?** | | [optional]
**TraceId** | **string** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.HandleForUpdateDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Values** | [**List&lt;HandleValueForUpdateDto&gt;**](HandleValueForUpdateDto.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.HandleValueDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Idx** | **int** | | [optional]
**Type** | **string** | | [optional]
**ParsedData** | **Object** | | [optional]
**Data** | **string** | | [optional]
**Timestamp** | **DateTime** | | [optional]
**TtlType** | **int** | | [optional]
**Ttl** | **int** | | [optional]
**Refs** | **List&lt;Object&gt;** | | [optional]
**Privs** | **string** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.HandleValueForUpdateDto
Data transfer object (DTO) representing updating a handle.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **string** | The data type of the handle. | [optional]
**ParsedData** | **Object** | The parsed data of the handle. | [optional]
**Idx** | **int** | The id of the handle. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.HashParametersDto
Data transfer object (DTO) representing Hash Parameters in a request.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AlgorithmName** | **string** | Gets or initializes the hash algorithm name. |
**Value** | **string** | Gets or initializes the hash value. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.IdentityProviderDto
Represents a Data Transfer Object (DTO) for an identity provider.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **Guid** | Gets or sets the unique identifier for the identity provider. | [optional]
**DisplayName** | **string** | Gets or sets the display name of the identity provider. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.IdentityProviders
Specifies the supported external authentication services.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Api.LanguageApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2LanguagesOptions**](LanguageApi.md#apiv2languagesoptions) | **OPTIONS** /api/v2/languages | Responds with the HTTP methods allowed for the endpoint. |
| [**GetLanguage**](LanguageApi.md#getlanguage) | **GET** /api/v2/languages/{languageId} | Retrieves a language by ID. |
| [**GetLanguages**](LanguageApi.md#getlanguages) | **GET** /api/v2/languages | Retrieves all languages. |
<a id="apiv2languagesoptions"></a>
# **ApiV2LanguagesOptions**
> void ApiV2LanguagesOptions ()
Responds with the HTTP methods allowed for the endpoint.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class ApiV2LanguagesOptionsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LanguageApi(config);
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2LanguagesOptions();
}
catch (ApiException e)
{
Debug.Print("Exception when calling LanguageApi.ApiV2LanguagesOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2LanguagesOptionsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2LanguagesOptionsWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling LanguageApi.ApiV2LanguagesOptionsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a id="getlanguage"></a>
# **GetLanguage**
> LanguageDtoResponse GetLanguage (Guid languageId)
Retrieves a language by ID.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetLanguageExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LanguageApi(config);
var languageId = "languageId_example"; // Guid | The ID of the language.
try
{
// Retrieves a language by ID.
LanguageDtoResponse result = apiInstance.GetLanguage(languageId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling LanguageApi.GetLanguage: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetLanguageWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves a language by ID.
ApiResponse<LanguageDtoResponse> response = apiInstance.GetLanguageWithHttpInfo(languageId);
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 LanguageApi.GetLanguageWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **languageId** | **Guid** | The ID of the language. | |
### Return type
[**LanguageDtoResponse**](LanguageDtoResponse.md)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the language. | - |
| **404** | Language does not exist. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a id="getlanguages"></a>
# **GetLanguages**
> LanguageDtoIEnumerableResponse GetLanguages (int? pageNumber = null, int? pageSize = null, string? orderBy = null)
Retrieves all languages.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetLanguagesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LanguageApi(config);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
// Retrieves all languages.
LanguageDtoIEnumerableResponse result = apiInstance.GetLanguages(pageNumber, pageSize, orderBy);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling LanguageApi.GetLanguages: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetLanguagesWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves all languages.
ApiResponse<LanguageDtoIEnumerableResponse> response = apiInstance.GetLanguagesWithHttpInfo(pageNumber, pageSize, orderBy);
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 LanguageApi.GetLanguagesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [optional] |
| **pageSize** | **int?** | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. | [optional] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
[**LanguageDtoIEnumerableResponse**](LanguageDtoIEnumerableResponse.md)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the languages. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.LanguageDto
Represents a Data Transfer Object (DTO) for language details.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **Guid** | Gets or sets the unique identifier for the language. | [optional]
**DisplayName** | **string** | Gets or sets the display name of the language. | [optional]
**Abbreviation** | **string** | Gets or sets the abbreviation for the language. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.LanguageDtoIEnumerableResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**List&lt;LanguageDto&gt;**](LanguageDto.md) | | [optional]
**IsSuccess** | **bool** | | [optional] [readonly]
**StatusCode** | **int?** | | [optional]
**TraceId** | **string** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.LanguageDtoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**LanguageDto**](LanguageDto.md) | | [optional]
**IsSuccess** | **bool** | | [optional] [readonly]
**StatusCode** | **int?** | | [optional]
**TraceId** | **string** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.LanguageForUserManipulationDto
Data transfer object (DTO) representing a language for user manipulation.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **Guid** | Gets or initializes the identifier of the language. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Api.LicenseApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2LicensesOptions**](LicenseApi.md#apiv2licensesoptions) | **OPTIONS** /api/v2/licenses | Responds with the HTTP methods allowed for the endpoint. |
| [**GetLicense**](LicenseApi.md#getlicense) | **GET** /api/v2/licenses/{licenseId} | Retrieves a license with the specified ID. |
| [**GetLicenses**](LicenseApi.md#getlicenses) | **GET** /api/v2/licenses | Retrieves all licenses. |
<a id="apiv2licensesoptions"></a>
# **ApiV2LicensesOptions**
> void ApiV2LicensesOptions ()
Responds with the HTTP methods allowed for the endpoint.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class ApiV2LicensesOptionsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LicenseApi(config);
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2LicensesOptions();
}
catch (ApiException e)
{
Debug.Print("Exception when calling LicenseApi.ApiV2LicensesOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2LicensesOptionsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2LicensesOptionsWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling LicenseApi.ApiV2LicensesOptionsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a id="getlicense"></a>
# **GetLicense**
> LicenseDtoResponse GetLicense (Guid licenseId)
Retrieves a license with the specified ID.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetLicenseExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LicenseApi(config);
var licenseId = "licenseId_example"; // Guid | The ID of the license.
try
{
// Retrieves a license with the specified ID.
LicenseDtoResponse result = apiInstance.GetLicense(licenseId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling LicenseApi.GetLicense: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetLicenseWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves a license with the specified ID.
ApiResponse<LicenseDtoResponse> response = apiInstance.GetLicenseWithHttpInfo(licenseId);
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 LicenseApi.GetLicenseWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **licenseId** | **Guid** | The ID of the license. | |
### Return type
[**LicenseDtoResponse**](LicenseDtoResponse.md)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the license. | - |
| **404** | License does not exist. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a id="getlicenses"></a>
# **GetLicenses**
> LicenseDtoPagedResponse GetLicenses (int? pageNumber = null, int? pageSize = null, string? orderBy = null)
Retrieves all licenses.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetLicensesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LicenseApi(config);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
// Retrieves all licenses.
LicenseDtoPagedResponse result = apiInstance.GetLicenses(pageNumber, pageSize, orderBy);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling LicenseApi.GetLicenses: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetLicensesWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves all licenses.
ApiResponse<LicenseDtoPagedResponse> response = apiInstance.GetLicensesWithHttpInfo(pageNumber, pageSize, orderBy);
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 LicenseApi.GetLicensesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [optional] |
| **pageSize** | **int?** | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. | [optional] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
[**LicenseDtoPagedResponse**](LicenseDtoPagedResponse.md)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the licenses. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.LicenseDto
Represents a Data Transfer Object (DTO) for license details.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **Guid** | Gets or sets the unique identifier for the license. | [optional]
**DisplayName** | **string** | Gets or sets the display name of the license. | [optional]
**Url** | **string** | Gets or sets the Uri of the license. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)