SAIF.Business.Policy.Audit.ApiCalls overview

Documentation context: Packaged Component (NuGet)

SAIF.Business.Policy.Audit.ApiCalls is a thin outbound integration library for Premium Audit document and audit-service calls. It does not model BOF business objects or local persistence; instead, it constructs three JSON/HTTP clients and the DTO payloads those downstream services expect.

Purpose

• Provide typed request clients for the Policy Audit API, the Document API, and the Policy Document Distribution API.
• Centralize the DTO contracts and contact/distribution metadata used by Premium Audit document-generation and audit-submission flows.

Responsibilities

• Resolve downstream API endpoints and caller identity through EnvironmentService.
• Retrieve NTLM credentials for the Policy Audit API from the secure environment store.
• Shape audit-term, waive-audit, document-distribution, and preset-distribution payloads.
• Forward all state-changing work to downstream services rather than persisting data locally.

Key components

• ApiCall: NTLM-authenticated Policy Audit API client for audit-term and waive-audit submissions.
• DocumentApiCall: fully specified Document API client for /v1/distribute.
• PolicyDocDistributionCall: preset-driven policy document distribution client for /v1/documents/distribute/presets.
• Distribution DTOs: DistributionRequest, DistributionConfig, DistributionOptions, and the channel option classes used by the older Document API path.
• Preset DTOs: PolicyDocumentConfig, ImagingMetadata, Contact and its subclasses, and Address used by the preset-driven path.

Related documentation

• Index
• Architecture
• Dependencies
• Operations and processes
• Business rules
• Security and authorization
• Configuration
• API reference

Sources

• Business\SAIF.Business.Policy.Audit.ApiCalls\SAIF.BOF.Business.Policy.Audit.ApiCalls.nuspec
• Business\SAIF.Business.Policy.Audit.ApiCalls\ApiCall.cs
• Business\SAIF.Business.Policy.Audit.ApiCalls\DocumentApiCall.cs
• Business\SAIF.Business.Policy.Audit.ApiCalls\PolicyDocDistributionCall.cs
• Business\SAIF.Business.Policy.Audit.ApiCalls\DistributionMethod.cs
• Business\SAIF.Business.Policy.Audit.ApiCalls\PolicyDocumentConfig.cs