TeamDbClientApi 3.14.0

TeamDbClientApi

This NuGet enables you to easily access the TeamDB Web API.

• Package version: 3.14.0
• TeamDB Web API version: 2.0

Requirements

• .NET 10.0+
• TeamDB 3.14.0

Installation and usage

dotnet install

Install via : dotnet add package

dotnet add package TeamDbClientApi

Then import the package:

using TeamDB.Client.Api;

Getting Started

Please follow the installation procedure above and then, depending your TeamDB WebApi configuration, try the following :

Using the HTTP protocole

// Import TeamDB Client API
using System.Net.Http.Headers;
using TeamDB.Client.Api;

// Create an AssemblyApi object
AssemblyApi assemblyApi = new AssemblyApi("http://localhost:9001"); // Replace with your TeamDB API address if different.

// Try to execute the request
try
{
    // Retrieve and print the current assembly before modification
    Assembly currentAssembly = assemblyApi.GetCurrentAssembly();
    Console.WriteLine("Current assembly name before modification: " + currentAssembly.Name);

    // Set the desired current assembly,
    await assemblyApi.SelectCurrentAssemblyAsync(assemblyId: Guid.Parse("452fe923-d624-4415-8d6a-bc0ed45c5e76")); // Replace with your own valid Assembly id.

    // Retrieve and print the current assembly after modification
    currentAssembly = assemblyApi.GetCurrentAssembly();
    Console.WriteLine("Current assembly name after modification: " + currentAssembly.Name);
}
catch (Exception ex)
{
    Console.WriteLine($"Exception when selecting the current assembly : {ex.Message}\n");
}

Using the HTTPS protocole

// Import TeamDB Client API
using System.Net.Http.Headers;
using TeamDB.Client.Api;

// Create an HttpClient to set the Authorization header with a Bearer token.
var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "user_token"); // Replace {user_token} by a valid TeamDB WebApi user token.

// Create an AssemblyApi object
AssemblyApi assemblyApi = new AssemblyApi("https://localhost:9001", client); // Replace with your TeamDB API address if different.

// Try to execute the request
try
{
    // Retrieve and print the current assembly before modification
    Assembly currentAssembly = assemblyApi.GetCurrentAssembly();
    Console.WriteLine("Current assembly name before modification: " + currentAssembly.Name);

    // Set the desired current assembly,
    await assemblyApi.SelectCurrentAssemblyAsync(assemblyId: Guid.Parse("452fe923-d624-4415-8d6a-bc0ed45c5e76")); // Replace with your own valid Assembly id.

    // Retrieve and print the current assembly after modification
    currentAssembly = assemblyApi.GetCurrentAssembly();
    Console.WriteLine("Current assembly name after modification: " + currentAssembly.Name);
}
catch (Exception ex)
{
    Console.WriteLine($"Exception when selecting the current assembly : {ex.Message}\n");
}

NOTE: Each method has an asynchronous version (for example: SelectCurrentAssembly ⇒ SelectCurrentAssemblyAsync). This can be useful, for example, if you want to work in multiple threads for routes that may take some time to respond.

Documentation for API Endpoints

With a TeamDB Client, check the documentation at http://localhost:9001 (Default value for the TeamDB Web API URL)

Documentation For Authorization

Endpoints are subject to the same authorization as in TeamDB.

Author

Trackside Software support@trackside.fr