Forcura.NPPESAPI
2.1.1
dotnet add package Forcura.NPPESAPI --version 2.1.1
NuGet\Install-Package Forcura.NPPESAPI -Version 2.1.1
<PackageReference Include="Forcura.NPPESAPI" Version="2.1.1" />
paket add Forcura.NPPESAPI --version 2.1.1
#r "nuget: Forcura.NPPESAPI, 2.1.1"
// Install Forcura.NPPESAPI as a Cake Addin
#addin nuget:?package=Forcura.NPPESAPI&version=2.1.1
// Install Forcura.NPPESAPI as a Cake Tool
#tool nuget:?package=Forcura.NPPESAPI&version=2.1.1
NPPES API for .NET
This is a .NET wrapper for interacting with the CMS National Plan and Provider Enumeration System NPPES National Provider Identifier (NPI) lookup system
For more information visit the NPI registry
Usage
Requests are as simple as providing an NPI number to lookup:
var results = await NPPESApiClient.SearchAsync("8942315671");
OR
var results = await NPPESApiClient.SearchAsync(new NPPESRequest
{
Number = "5631047582"
});
For more complicated queries, use the other provided fields on the NPPESRequest
object:
var results = await NPPESApiClient.SearchAsync(new NPPESRequest
{
FirstName = "John",
LastName = "Doe"
});
Using the builder:
var builder = new NPPESRequestBuilder();
var request = builder
.Version(NPPESVersion.v1_0)
.Number("1234567890")
.Build();
var results = await NPPESApiClient.SearchAsync(request);
Dependency Injection
For netcore/net5+ you can register this with the IServiceCollection
through the extension method:
using Forcura.NPPES.DependencyInjection;
// simple approach
IServiceCollection serviceCollection = ...;
serviceCollection.AddNPPESApi();
// for any customizations of the IHttpClientBuilder
IServiceCollection serviceCollection = ...;
serviceCollection.AddHttpClient<NPPESApiClient>();
It is important to note that the NPPES API by default, accesses the latest public api version, as currently it is backward compatible, this is something to be aware of.
License
Copyright 2022 Forcura
Licensed under the Apache 2.0 license
Resources
Product | Versions |
---|---|
.NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows |
.NET Core | netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1 |
.NET Standard | netstandard1.5 netstandard1.6 netstandard2.0 netstandard2.1 |
.NET Framework | net461 net462 net463 net47 net471 net472 net48 net481 |
MonoAndroid | monoandroid |
MonoMac | monomac |
MonoTouch | monotouch |
Tizen | tizen30 tizen40 tizen60 |
Xamarin.iOS | xamarinios |
Xamarin.Mac | xamarinmac |
Xamarin.TVOS | xamarintvos |
Xamarin.WatchOS | xamarinwatchos |
-
.NETStandard 1.5
- NETStandard.Library (>= 1.6.1)
- Newtonsoft.Json (>= 13.0.1)
-
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.1)
-
.NETStandard 2.1
- Newtonsoft.Json (>= 13.0.1)
-
net5.0
- Microsoft.Extensions.DependencyInjection (>= 5.0.0)
- Microsoft.Extensions.Http (>= 5.0.0)
- Newtonsoft.Json (>= 13.0.1)
-
net6.0
- Microsoft.Extensions.DependencyInjection (>= 6.0.0)
- Microsoft.Extensions.Http (>= 6.0.0)
- Newtonsoft.Json (>= 13.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Update to support the following Rest API breaking changes:
* `result_count` was renamed to `resultCount`
* Timestamps are now milliseconds from the epoch instead of seconds from the epoch
Other changes:
* Using version 1.0 and 2.0 requests will provide a deprecation warning