VTigerNetApi 2024.11.27.102

dotnet add package VTigerNetApi --version 2024.11.27.102                
NuGet\Install-Package VTigerNetApi -Version 2024.11.27.102                
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="VTigerNetApi" Version="2024.11.27.102" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add VTigerNetApi --version 2024.11.27.102                
#r "nuget: VTigerNetApi, 2024.11.27.102"                
#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.
// Install VTigerNetApi as a Cake Addin
#addin nuget:?package=VTigerNetApi&version=2024.11.27.102

// Install VTigerNetApi as a Cake Tool
#tool nuget:?package=VTigerNetApi&version=2024.11.27.102                

cammUtils-vTigerNetApi

A library written in C# which allows easy access to the VTiger CRM webservice (for VTiger V6 or later). It is capable to use every aspect of the VTiger-Webservice as is. NuGet VTigerNetApi

Short example of using the VTiger .NET API

The following code is a brief example of how to use the VTiger .NET API to access the VTiger CRM database.

// Create the VTiger object and set the destination URL for the VTiger-webservice
VTiger vtigerApi= new VTiger("http://localhost:8888");

// Process login with a username and it's matching authentication-key (see NOTE 1)
vtigerApi.Login("admin", "oQJ4I0h89gpir0zG");

// Query some elements (see NOTE 2)
DataTable dt = vtigerApi.Query("SELECT id, invoice_no FROM Invoice WHERE invoice_no='INV1';");

if (dt.Rows.Count > 0)
{
      // Retrieve all data of the entity from VTiger
      VTigerInvoice invoiceData = vtigerApi.Retrieve<VTigerInvoice>((string)dt.Rows[0]["id"]);

      // Display some of that data
      MessageBox.Show("Invoice INV1 has a grand-total of " + invoiceData.hdnGrandTotal.ToString());
}

Notes

Please also review https://www.vtiger.com/docs/rest-api-for-vtiger and https://community.vtiger.com/help/vtigercrm/developers/third-party-app-integration.html for general notes on using the VTiger Webservice API.

NOTE 1 about VTiger-Login: In order to log in, you need the authentication-key which can be found in user's profile-settings.

NOTE 2 about VTiger-Queries: Due to restrictions in the VTiger-webservice, neither "not" nor parenthesis work in queries. If larger select-statements need to be constructed you can use the VTigerQueryWriter-class included in the project (recommended).

NOTE 3 about VTiger-Update: There is a problem caused by vtiger being unable to update some tables because they seem not to be indended to be updated. Nonetheless vtiger throws no error when trying to update those tables resulting in corrupted entries. For now we know that this is the case for the tables quotes and sales-orders. Because of that we highly recommend not updating that table and consider it as read-only.

Some important information regarding VTiger-Queries

The VTiger-queries are NOT processed by SQL, but instead of a special parser inside VTiger and then rebuilt as SQL query for the actual VTiger database! Because of that there are some kind of restrictions like the one described in NOTE 2.

Trouble shooting

If you have any trouble building queries or you have problems regarding the data returned by VTiger you should first try using the VTigerManagerDemo and see what VTiger returnes and what queries can be executed.

About

This project started as part of an internship and at last, this API would have never existed, if our trainee didn't get that chance by having an internship.

VTiger demo portals

To connect your application with a running instance quickly, you might consider using a public VTiger demo portal. Here is a list of external vendors providing a public VTiger demo poral:

VTiger Version Support

  • V5: supported
  • V6: supported
  • V7: supported
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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
2024.11.27.102 82 11/27/2024
2024.11.27.101 73 11/27/2024
2024.11.27.100 67 11/27/2024
2024.11.26.200 70 11/26/2024
2024.11.26.102 74 11/26/2024
2024.11.26.101 78 11/26/2024
2020.11.13.100 1,251 11/13/2020
2019.2.21.101 1,297 2/21/2019
2019.2.21.100 1,057 2/21/2019
2017.9.6.100 1,422 9/6/2017
2017.8.29.100 1,302 8/29/2017
2017.8.24.100 1,269 8/24/2017
2017.8.21.100 1,330 8/21/2017
2017.8.8.100 1,289 8/8/2017
2017.4.6.102 1,346 8/8/2017
2017.4.6.101 1,296 8/8/2017