Skip to content

SAIF.Business.Policy.Audit.ApiCalls operations and processes

This page catalogs the outbound integration operations implemented by SAIF.Business.Policy.Audit.ApiCalls. Detailed step-by-step behavior lives in the operation pages under operations/.

Operation catalog

Operation Intent Trigger Inputs Outputs Rules Tables SQL
Construct the Policy Audit API client Resolve endpoint, caller identity, and NTLM credentials for the Policy Audit API. A caller instantiates ApiCall. None. Initialized JsonHttpClient stored inside ApiCall. BR-AAC-001, BR-AAC-002, BR-AAC-003, BR-AAC-004, BR-AAC-005 N/A N/A
Post audit policy terms to the Policy Audit API Submit audit policy terms to a caller-selected Policy Audit API route. A caller invokes PolicyAuditAPICall(auditCollection, method). AuditCollection auditCollection, string method. bool success flag. BR-AAC-006, BR-AAC-007 N/A N/A
Post a waive-audit request Submit waive-audit items to a caller-selected Policy Audit API route. A caller invokes WaiveAPICall(auditCollection, method). WaveAuditCollection auditCollection, string method. string wrapper representation. BR-AAC-006, BR-AAC-008 N/A N/A
Construct the Document API client Resolve endpoint and caller identity for the Document API. A caller instantiates DocumentApiCall. None. Initialized JsonHttpClient stored inside DocumentApiCall. BR-AAC-001, BR-AAC-002, BR-AAC-003, BR-AAC-009 N/A N/A
Generate and distribute a document through the Document API Build a one-distribution Document API request and post it to /v1/distribute. A caller invokes CallDocumentApi(packageName, documentXml, options). string packageName, string documentXml, DistributionOptions options. bool success flag. BR-AAC-010, BR-AAC-011, BR-AAC-012, BR-AAC-013, BR-AAC-014, BR-AAC-015, BR-AAC-016, BR-AAC-017 N/A N/A
Construct the Policy Document Distribution client Resolve endpoint and caller identity for preset-based policy document distribution. A caller instantiates PolicyDocDistributionCall. None. Initialized JsonHttpClient stored inside PolicyDocDistributionCall. BR-AAC-001, BR-AAC-002, BR-AAC-003, BR-AAC-009 N/A N/A
Distribute a policy document using presets Post a preset-driven policy document payload to the distribution API. A caller invokes DistributeApiCall(documentConfig). PolicyDocumentConfig documentConfig. bool success flag. BR-AAC-018 N/A N/A
Resolve a contact's type and carbon-copy name Translate policy-document contacts into service recipient codes and CC display text. A caller or serializer reads ContactType, CCName, or IsValidContactType on the contact model. Contact state or a caller-supplied contact-type code. Recipient code validation or formatted CC text. BR-AAC-019, BR-AAC-020, BR-AAC-021 N/A N/A
Report a distribution channel's discriminator Expose the class-name discriminator used by channel options. A caller or serializer reads DistributionMethodType from a distribution-channel object. Concrete channel type parameter T. Channel discriminator string. BR-AAC-022 N/A N/A

Process flow diagram

The following diagram shows how callers move through the library's three major integration paths.

flowchart TD
  Caller[Caller] --> Choice{Requested service}
  Choice --> Audit[Policy Audit API]
  Choice --> Doc[Document API]
  Choice --> Preset[Preset distribution API]
  Audit --> Payload1[AuditCollection or WaveAuditCollection]
  Doc --> Payload2[DistributionRequest]
  Preset --> Payload3[PolicyDocumentConfig]
  Payload1 --> Http[JsonHttpClient]
  Payload2 --> Http
  Payload3 --> Http

Failure and edge-case behavior

  • Client construction fails early when a required endpoint URL or secure credential setting is missing or malformed.
  • PolicyAuditAPICall treats an empty Results collection as false.
  • WaiveAPICall returns a wrapper string rather than a boolean decision.
  • CallDocumentApi suppresses exceptions after writing the exception message to Console and reports failure with false.
  • DistributeApiCall always returns true, even though the response body is not inspected.

Sources

  • 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