polarisilskit's Introduction

PolarisILSKit

PolarisILSKit is a .NET Standard 2.0 library for communicating with the Polaris ILS, available as a package from the NuGet Gallery.

This project is based on the CLC Polaris API Helper Library (which is available in the NuGet Gallery as PolarisApiLibrary). It includes bug fixes and enhancements to the original PolarisApiLibrary package.

Using the Polaris API Helper Library

Staff account credentials are only required for protected methods and overriding public methods

Installation

Install-Package PolarisILSKit -Pre

Usage

Public Method

var papi = new PapiClient
            {
                AccessID = "your-access-id",
                AccessKey = "your-access-secret",
                BaseUrl = "https://papi.yoursite.org"
            };

            var patron = papi.PatronCirculateBlocksGet("123000000456", "0000");
            Console.WriteLine($"Hello {patron.Data.NameFirst}");

Protected Method

var papi = new PapiClient
            {
                AccessID = "your-access-id",
                AccessKey = "your-access-secret",
                BaseUrl = "https://papi.yoursite.org",
                StaffOverrideAccount = new PolarisUser
                {
                    Domain = "domain",
                    Username = "staff",
                    Password = "password"
                }
            };

            var value = papi.SA_GetValueByOrg(1, "orgphone1");
            Console.WriteLine(value);

Public Method Override

var papi = new PapiClient
            {
                AccessID = "your-access-id",
                AccessKey = "your-access-secret",
                BaseUrl = "https://papi.yoursite.org",
                StaffOverrideAccount = new PolarisUser
                {
                    Domain = "domain",
                    Username = "staff",
                    Password = "password"
                }
            };

            var patron = papi.PatronBasicDataGetOverride("123000000456");
            Console.WriteLine($"Hello {patron.Data.PatronBasicData.NameFirst}");

License

The basis of this project (CLC Polaris API Helper Library) was released under the GPL v3.0 license requiring all changes to be released under the same license.

Recommend Projects