Skip to content

API client package documentation

SAIF.Agency.Api.Client is the supported way for internal .NET Framework applications to read agency, agent, and appointment data from SAIF.Agency.Api. It wraps the v1/agencies routes behind a four-member interface, hides URL composition and JSON deserialization behind JsonHttpClient, and ships the shared SAIF.Agency.Api.Core contracts so that callers bind to the same DTOs the API returns. SAIF.Claims.Intake, SAIF.Policy.RenewalNotice, and the agency portal all consume it rather than issuing their own HTTP calls.

Field Value
Package id SAIF.Agency.Api.Client
Assembly SAIF.Agency.Api.Client.dll
Framework .NET Framework 4.8 (lib\net48)
Client class AgencyClient : IAgencyClient
HTTP surface SAIF.Web.API.Clients.JsonHttpClient
Wrapped API SAIF.Agency.Api
Shared contracts SAIF.Agency.Api.Core

Documentation sections

Section Description
Overview What the client wraps, who consumes it, and capability summary
Architecture Internal structure, JsonHttpClient wrapping, and construction
Package nuspec identity, version, dependencies, shipped content, feed, and pipeline
Client reference One section per public member of the client interface
Endpoint map Client method → API endpoint traceability
Consumption How a consumer constructs and calls the client
Contracts The shared DTO/contracts assembly
Dependencies Packages, framework components, and the wrapped API
Business rules Rules enforced client-side before or after the call
Tech debt CRITICAL and HIGH severity findings

Wrapped API

Attribute Value
API name SAIF.Agency.Api
Documented by this run Yes
API documentation SAIF.Agency.Api
Base URI source Constructor argument; consumers pass the AgencyApi.BaseUrl app setting
Version suffix v1/

Sources

  • src/SAIF.Agency.Api.Client/AgencyClient.cs
  • src/SAIF.Agency.Api.Client/IAgencyClient.cs
  • src/SAIF.Agency.Api.Client/SAIF.Agency.Api.Client.csproj
  • scripts/SAIF.Agency.Api.Client/SAIF.Agency.Api.Client.nuspec