LocalGovImsApiClient - the C# library for the LocalGovImsApi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

• API version: 1.0.0
• SDK version: 1.0.0
• Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 12.0.3 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

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.

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

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

using LocalGovImsApiClient.Api;
using LocalGovImsApiClient.Client;
using LocalGovImsApiClient.Model;

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;

Getting Started

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

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

            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            var apiInstance = new AccountHoldersApi(config);
            var reference = "reference_example";  // string | 

            try
            {
                AccountHolderModel result = apiInstance.AccountHoldersGet(reference);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AccountHoldersApi.AccountHoldersGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AccountHoldersApi	AccountHoldersGet	GET /api/AccountHolders/{reference}
AccountHoldersApi	AccountHoldersPatch	PATCH /api/AccountHolders
AccountHoldersApi	AccountHoldersPost	POST /api/AccountHolders
FundMetadataApi	FundMetadataGet	GET /api/FundMetadata/{key}/{fundCode}
FundsApi	FundsGet	GET /api/Funds/{fundCode}
MethodOfPaymentsApi	MethodOfPaymentsSearch	GET /api/MethodOfPayments
NotificationApi	NotificationPost	POST /api/Notification
PendingTransactionsApi	PendingTransactionsAuthorise	POST /api/PendingTransaction/{reference}/Authorise
PendingTransactionsApi	PendingTransactionsGet	GET /api/PendingTransactions/{reference}
PendingTransactionsApi	PendingTransactionsPost	POST /api/PendingTransactions
PendingTransactionsApi	PendingTransactionsProcessFee	POST /api/ProcessedTransactions/{reference}/ProcessFee
PendingTransactionsApi	PendingTransactionsProcessPayment	POST /api/PendingTransaction/{reference}/ProcessPayment
ProcessedTransactionsApi	ProcessedTransactionsGet	GET /api/ProcessedTransactions/{reference}
ProcessedTransactionsApi	ProcessedTransactionsPost	POST /api/ProcessedTransactions
ProcessedTransactionsApi	ProcessedTransactionsSearch	GET /api/ProcessedTransactions
SuspenseApi	SuspenseGet	GET /api/Suspense/{id}
SuspenseApi	SuspensePost	POST /api/Suspense
SuspenseApi	SuspenseSearch	GET /api/Suspense

Documentation for Models

• Model.AccountHolderModel
• Model.AuthoriseModel
• Model.FundMetadataModel
• Model.FundModel
• Model.MethodOfPaymentModel
• Model.NotificationModel
• Model.PendingTransactionModel
• Model.ProcessFeeModel
• Model.ProcessPaymentModel
• Model.ProcessPaymentResponse
• Model.ProcessedTransactionModel
• Model.SuspenseModel

Documentation for Authorization

All endpoints do not require authorization.