XycloneDesigns.Apis.General
2.1.0
dotnet add package XycloneDesigns.Apis.General --version 2.1.0
NuGet\Install-Package XycloneDesigns.Apis.General -Version 2.1.0
<PackageReference Include="XycloneDesigns.Apis.General" Version="2.1.0" />
<PackageVersion Include="XycloneDesigns.Apis.General" Version="2.1.0" />
<PackageReference Include="XycloneDesigns.Apis.General" />
paket add XycloneDesigns.Apis.General --version 2.1.0
#r "nuget: XycloneDesigns.Apis.General, 2.1.0"
#:package XycloneDesigns.Apis.General@2.1.0
#addin nuget:?package=XycloneDesigns.Apis.General&version=2.1.0
#tool nuget:?package=XycloneDesigns.Apis.General&version=2.1.0
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 | Versions 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. |
-
net8.0
- Newtonsoft.Json (>= 13.0.3)
- XycloneDesigns.Extensions.CSharp (>= 1.0.4)
- XycloneDesigns.Extensions.SQLite (>= 1.0.0)
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.
Parameter Updates and Reworks