XycloneDesigns.Apis.General 1.2.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package XycloneDesigns.Apis.General --version 1.2.0
                    


                    

                
NuGet\Install-Package XycloneDesigns.Apis.General -Version 1.2.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="XycloneDesigns.Apis.General" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="XycloneDesigns.Apis.General" Version="1.2.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="XycloneDesigns.Apis.General" />
                    


                            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 XycloneDesigns.Apis.General --version 1.2.0
                    


                    

                
#r "nuget: XycloneDesigns.Apis.General, 1.2.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 XycloneDesigns.Apis.General@1.2.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=XycloneDesigns.Apis.General&version=1.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=XycloneDesigns.Apis.General&version=1.2.0
                    


                            Install as a Cake Tool

Xyclone Designs General API Wrapper

A simple wrapper to the Xyclone Designs General API.

Include the library and then make calls to the various API end points.

Usage

<pre><code class='language-cs'> [Type].Request request = new [Type].Request(<args>) { ... };

HttpClient httpclient = new HttpClient(); using HttpRequestMessage httprequestmessage = request.ToHttpRequestMessage(); using HttpResponseMessage httpresponsemessage = await httpclient.SendAsync(httprequestmessage);

string json = await httpresponsemessage.Content.ReadAsStringAsync();

// System.Text.Json [Type].Response response = JsonSerializer.Deserialize<[Type]>(json);

// Newtonsoft [Type].Response response = JObject.Parse(json).ToObject<[Type].Response>();

</code></pre>

REST

Visit api.xyclonedesigns.co.za/general/rest for a more comprehensive swagger documentation in regards to the API.

General Request

<pre> public class Request { public int Page { get; set; } = 1; public int PageSize { get; set; } = 10; public string[] OrderBy { get; set; } = []; public int[] Pk { get; set; } = []; public bool Reverse { get; set; } = false;

// Countries...
public string[]? Code { get; set; }

// Districts...
public string[]? Code { get; set; }

// Languages...
public string[]? Code { get; set; }

// Municipalities...
public string[]? GeoCode { get; set; }

// Provinces...
public string[]? Code { get; set; }

} </pre>

General Response

<pre> public class Reponse { public int Count { get; set; } = 1; public int Page { get; set; } = 1; public int Pages { get; set; } = 1; public IEnumerable<T> Items { get; set; } = Enumerable.Empty<T>(); } </pre>

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 (5)

Showing the top 5 NuGet packages that depend on XycloneDesigns.Apis.General:

Package Downloads
XycloneDesigns.Apis.SAPS

Companion package for Xyclone Designs SAPS Crime Stats Api & xyclone-designs/database.sapscrime github project
XycloneDesigns.Apis.MunicipalMoney

Package for Municipal Money Api consumption and companion models for brevity
XycloneDesigns.Apis.Afrobarometer

Companion package for the xyclone-designs/database.afrobarometer github project
XycloneDesigns.Apis.IEC

Companion package for Xyclone Designs IEC Api & xyclone-designs/database.iec github project
XycloneDesigns.Apis.ETenders

Companion package for ETenders Api found at https://ocds-api.etenders.gov.za/

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.1.0 125 8/4/2025
2.0.0 37 8/2/2025
1.4.0 343 7/21/2025
1.2.0 148 7/12/2025
1.1.8 148 7/1/2025
1.1.6 83 6/28/2025

JSON Serialisation compatibility added