TagorDotNET 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
Suggested Alternatives

GDWInnovations.TagorClient

dotnet add package TagorDotNET --version 1.0.0
                    


                    

                
NuGet\Install-Package TagorDotNET -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="TagorDotNET" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="TagorDotNET" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="TagorDotNET" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add TagorDotNET --version 1.0.0
                    


                    

                
#r "nuget: TagorDotNET, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package TagorDotNET@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=TagorDotNET&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=TagorDotNET&version=1.0.0
                    


                            Install as a Cake Tool

TagorClient - the C# library for the Tagor API

Tagor release date: 29/09/2022

This C# SDK is automatically generated by the OpenAPI Generator project. Recreate this using this command

openapi-generator-cli generate -i TagorApi.yaml -g csharp -o TagorClient --additional-properties=packageName=TagorClient

REQUIREMENTS

This version requires Tagor >= 2.00.0000B0. Use Config/Info to get the active API version.

CHANGELOG

  • New Dossier/CreateAgenda endpoint.
  • New return values in GetAgenda 'TJOB_Id, TJOBM_Id, TUSER_Id, Manueel and IsGeblokkeerd'
  • In CreateLine you can now add if the line is fixed with 'IsFixed'
  • In CreateLine you can now add a subarray with the intrests

INFO

  • Using the download button at the top you can import this collection of endpoints in Postman
  • In general all TQ(...)_Id fields are default fields which you can translate with the Code/GetDescription endpoint. If you need an id to post to one of the endpoints you can use the Code/GetList endpoint to get all possible values or Code/GetDescription to get a value by code. These id's will be marked as code id in the documentation.
  • We chose to return all ids as string because these are 64bit integers which are too big for javascript to handle.
  • All italic text below the endpoint description is meant for people with access to Tagor.
  • The user needs an email address configured in Tagor for the services to work properly.
  • Pass the Accept header with application/json as value to have the server return errors in json format.
  • Most endpoints can be batched/paged by passing a BATCH-SIZE and BATCH-NUMBER record in dsWebContext.

AUTHENTICATION

Pass your token via an Authorization header like this: Authorization: {bearer_format} {token}.

ex: Authorization: TGR IcoQbVw7wE...PPUPda61ET <!- - ReDoc-Inject: <security-definitions> - →

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.00.0000B1
  • SDK version: 1.0.0
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen

<a id="frameworks-supported"></a>

Frameworks supported

<a id="dependencies"></a>

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a id="installation"></a>

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using TagorClient.Api;
using TagorClient.Client;
using TagorClient.Model;

<a id="packaging"></a>

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out TagorClient.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

<a id="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a id="getting-started"></a>

Getting Started

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

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://localhost/v1/web";
            // Configure Bearer token for authorization: Pin
            config.AccessToken = "YOUR_BEARER_TOKEN";
            // Configure Bearer token for authorization: Orng
            config.AccessToken = "YOUR_BEARER_TOKEN";
            // Configure Bearer token for authorization: Hash
            config.AccessToken = "YOUR_BEARER_TOKEN";
            // Configure Bearer token for authorization: Tgr
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ActionsApi(config);
            var actionsSendMailRequest = new ActionsSendMailRequest?(); // ActionsSendMailRequest? |  (optional) 

            try
            {
                // Actions/SendMail
                ActionsSendMail200Response result = apiInstance.ActionsSendMail(actionsSendMailRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ActionsApi.ActionsSendMail: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a id="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://localhost/v1/web

Class Method HTTP request Description
ActionsApi ActionsSendMail POST /Actions/SendMail Actions/SendMail
ActionsApi ActionsSendSms POST /Actions/SendSms Actions/SendSms
CodeApi CodeGetDescription POST /Code/GetDescription Code/GetDescription
CodeApi CodeGetList POST /Code/GetList Code/GetList
ConfigApi ConfigDefendantSettings POST /Config/DefendantSettings Config/DefendantSettings
ConfigApi ConfigGetRequestableDocuments POST /Config/GetRequestableDocuments Config/GetRequestableDocuments
ConfigApi ConfigInfo POST /Config/Info Config/Info
ConfigApi ConfigPing POST /Config/Ping Config/Ping
ConfigApi ConfigPingGet GET /Config/Ping Config/Ping
ConfigApi ConfigUser POST /Config/User Config/User
ConfigApi ConfigVersion POST /Config/Version Config/Version
DocumentApi DocumentGenerate POST /Document/Generate Document/Generate
DocumentApi DocumentGet POST /Document/Get Document/Get
DocumentApi DocumentGetFile POST /Document/GetFile Document/GetFile
DocumentApi DocumentGetMergefield POST /Document/GetMergefield Document/GetMergefield
DossierApi DossierAddAttachment POST /Dossier/AddAttachment Dossier/AddAttachment
DossierApi DossierCreateAgenda POST /Dossier/CreateAgenda Dossier/CreateAgenda
DossierApi DossierCreateInfoLine POST /Dossier/CreateInfoLine Dossier/CreateInfoLine
DossierApi DossierCreateLine POST /Dossier/CreateLine Dossier/CreateLine
DossierApi DossierGet POST /Dossier/Get Dossier/Get
DossierApi DossierGetAgenda POST /Dossier/GetAgenda Dossier/GetAgenda
DossierApi DossierGetAppearance POST /Dossier/GetAppearance Dossier/GetAppearance
DossierApi DossierGetBalances POST /Dossier/GetBalances Dossier/GetBalances
DossierApi DossierGetByDefendant POST /Dossier/GetByDefendant Dossier/GetByDefendant
DossierApi DossierGetCorrespondence POST /Dossier/GetCorrespondence Dossier/GetCorrespondence
DossierApi DossierGetInfo POST /Dossier/GetInfo Dossier/GetInfo
DossierApi DossierGetLines POST /Dossier/GetLines Dossier/GetLines
DossierApi DossierGetParties POST /Dossier/GetParties Dossier/GetParties
DossierApi DossierGetPaymentPlans POST /Dossier/GetPaymentPlans Dossier/GetPaymentPlans
DossierApi DossierGetSub POST /Dossier/GetSub Dossier/GetSub
DossierApi DossierGetTitle POST /Dossier/GetTitle Dossier/GetTitle
DossierApi DossierSearch POST /Dossier/Search Dossier/Search
DossierApi DossierStop POST /Dossier/Stop Dossier/Stop
DossierlijnApi DossierlijnCreateInfoLine POST /Dossierlijn/CreateInfoLine Dossierlijn/CreateInfoLine
DossierlijnApi DossierlijnDeleteInfoLine POST /Dossierlijn/DeleteInfoLine Dossierlijn/DeleteInfoLine
DossierlijnApi DossierlijnGetInfo POST /Dossierlijn/GetInfo Dossierlijn/GetInfo
LoginApi LoginToken POST /Login/Token Login/Token
MessageApi MessageAdd POST /Message/Add Message/Add
MessageApi MessageGetListFilter POST /Message/GetListFilter Message/GetListFilter
MessageApi MessageGetLog POST /Message/GetLog Message/GetLog
MessageApi MessageGetMessage POST /Message/GetMessage Message/GetMessage
MessageApi MessageGetSenderReceiverList POST /Message/GetSenderReceiverList Message/GetSenderReceiverList
MessageApi MessageToggleRead POST /Message/ToggleRead Message/ToggleRead
PartyApi PartyAddContactDetail POST /Party/AddContactDetail Party/AddContactDetail
PartyApi PartyDeleteContactDetail POST /Party/DeleteContactDetail Party/DeleteContactDetail
PartyApi PartyGetAddresses POST /Party/GetAddresses Party/GetAddresses
PartyApi PartyGetContactDetails POST /Party/GetContactDetails Party/GetContactDetails
PartyApi PartySearch POST /Party/Search Party/Search
PayApi PayFinish POST /Pay/Finish Pay/Finish
PayApi PayStart POST /Pay/Start Pay/Start
SolvencyReportApi SolvencyReportGet POST /SolvencyReport/Get SolvencyReport/Get
SolvencyReportApi SolvencyReportGetList POST /SolvencyReport/GetList SolvencyReport/GetList
SolvencyReportApi SolvencyReportSave POST /SolvencyReport/Save SolvencyReport/Save
TagorServiceApi TagorServiceApprovePaymentPlan POST /TagorService/ApprovePaymentPlan TagorService/ApprovePaymentPlan
TagorServiceApi TagorServiceClipToFile POST /TagorService/ClipToFile TagorService/ClipToFile
TagorServiceApi TagorServiceFileToHash POST /TagorService/FileToHash TagorService/FileToHash
TagorServiceApi TagorServiceGetDosInfo POST /TagorService/GetDosInfo TagorService/GetDosInfo
TagorServiceApi TagorServiceGetPaymentPlanCriteria POST /TagorService/GetPaymentPlanCriteria TagorService/GetPaymentPlanCriteria
TagorServiceApi TagorServiceGetSaldo POST /TagorService/GetSaldo TagorService/GetSaldo
TagorServiceApi TagorServiceGetVoxtronReferentie POST /TagorService/GetVoxtronReferentie TagorService/GetVoxtronReferentie
TagorServiceApi TagorServiceGetVoxtronVerwByHuisNr POST /TagorService/GetVoxtronVerwByHuisNr TagorService/GetVoxtronVerwByHuisNr
TagorServiceApi TagorServiceGetVoxtronVerwByPin POST /TagorService/GetVoxtronVerwByPin TagorService/GetVoxtronVerwByPin
TagorServiceApi TagorServiceHashToFile POST /TagorService/HashToFile TagorService/HashToFile
TagorServiceApi TagorServiceKantoorOpen POST /TagorService/KantoorOpen TagorService/KantoorOpen
TagorServiceApi TagorServiceOnlinePaymentReceived POST /TagorService/OnlinePaymentReceived TagorService/OnlinePaymentReceived
TagorServiceApi TagorServicePaymentDetails POST /TagorService/PaymentDetails TagorService/PaymentDetails
TagorServiceApi TagorServicePaymentInfo POST /TagorService/PaymentInfo TagorService/PaymentInfo
TagorServiceApi TagorServicePinToFile POST /TagorService/PinToFile TagorService/PinToFile
TagorServiceApi TagorServiceSavePaymentPlan POST /TagorService/SavePaymentPlan TagorService/SavePaymentPlan
TagorServiceApi TagorServiceScanBarcode POST /TagorService/ScanBarcode TagorService/ScanBarcode
TagorServiceApi TagorServiceSelfServiceAllowed POST /TagorService/SelfServiceAllowed TagorService/SelfServiceAllowed
TagorServiceApi TagorServiceSendMail POST /TagorService/SendMail TagorService/SendMail
TagorServiceApi TagorServiceSendSms POST /TagorService/SendSms TagorService/SendSms
TagorServiceApi TagorServiceSetUserDossier POST /TagorService/SetUserDossier TagorService/SetUserDossier
UserApi UserAdd POST /User/Add User/Add
UserApi UserCanAccess POST /User/CanAccess User/CanAccess
UserApi UserGet POST /User/Get User/Get
UserApi UserGetPermissions POST /User/GetPermissions User/GetPermissions
UserApi UserGetPermissionsList POST /User/GetPermissionsList User/GetPermissionsList
UserApi UserSavePermissions POST /User/SavePermissions User/SavePermissions
UserApi UserSavePermissionsList POST /User/SavePermissionsList User/SavePermissionsList

<a id="documentation-for-models"></a>

Documentation for Models

<a id="documentation-for-authorization"></a>

Documentation for Authorization

Authentication schemes defined for the API: <a id="Tgr"></a>

Tgr

  • Type: Bearer Authentication

<a id="Hash"></a>

Hash

  • Type: Bearer Authentication

<a id="Pin"></a>

Pin

  • Type: Bearer Authentication

<a id="Orng"></a>

Orng

  • Type: Bearer Authentication
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 194 1/17/2025 1.0.0 is deprecated because it is no longer maintained.

Initial version