MichelMichels.BpostSharp.Web 1.0.1

<h1 align="center"> ✉️ BpostSharp </h1>

<br />

<div align="center"> This projects is a C# wrapper library to obtain Belgian city data from bpost (Belgian national mail service). </div>

<br /> <br />

<details> <summary>Table of Contents</summary>

• Prerequisites
• Building
• Installation
• Getting started
  • Example code
• Code explanation
• Credits

</details>

Prerequisites

• .NET 8.0

Building

Use Visual Studio 2022 to build the project.

Installation

Get the NuGet packages from nuget.org or search for MichelMichels.BpostSharp in the GUI package manager in Visual Studio.

You can also use the cli of the package manager with following command:

Install-Package MichelMichels.BpostSharp
Install-Package MichelMichels.BpostSharp.Excel
Install-Package MichelMichels.BpostSharp.Web

<br /> <hr>

Getting started

There are 2 versions of BpostSharp:

These 2 versions have following dependency:

Example code

Creating a web instance:

ICacheBuilder<CityData> webCacheBuilder = new WebCacheBuilder(BpostWebConstants.DutchEndpoint);
ICityDataService cityDataService = new BelgianCityDataService(webCacheBuilder);

Creating an excel instance:

ICacheBuilder<CityData> webCacheBuilder = new ExcelCacheBuilder("excel-from-bpost.xls");
ICityDataService cityDataService = new BelgianCityDataService(webCacheBuilder);

Querying data:

// Querying by postal code
CityData data = await cityDataService.GetByPostalCode("9000");

// Querying by city name
CityData data = await cityDataService.GetByCityName("Gent");

Code explanation

The querying uses StartsWith(...) and ignores casing.

Data is saved into cache after executing Build() on the ICacheBuilder or after first query, whichever comes earlier. You can clear the cache with Clear().

Credits

Written by Michel Michels.