Skip to content

DistributionRequest

Top-level Document API request payload for generated-document distribution.

Compilation status: This type is defined in Business\SAIF.Business.Policy.Audit.ApiCalls\DistributionRequest.cs, which is present in this library's source directory but is not listed in the <Compile> item group of SAIF.BOF.Business.Policy.Audit.ApiCalls.csproj. It is a source-included artifact and is not part of the compiled SAIF.Business.Policy.Audit.ApiCalls assembly's public surface.

Purpose

  • Combine submitter identity, document XML, and one or more distribution entries into the contract expected by /v1/distribute.

Context

  • Namespace: SAIF.Business.Policy.Audit.ApiCalls
  • Assembly/package: SAIF.Business.Policy.Audit.ApiCalls

Public members

Member Signature Purpose
Username public string Username { get; set; } Submitter identity attached to the request; DocumentApiCall always sets this to PremAudit (BR-AAC-010).
BaseDocumentXML public string BaseDocumentXML { get; set; } Generated document XML content that the Document API renders and distributes.
Distributions public DistributionConfig[] Distributions { get; set; } One or more distribution entries describing how the document should be delivered; DocumentApiCall always populates exactly one entry (BR-AAC-011).

Behavioral notes

  • DocumentApiCall always populates this type with exactly one DistributionConfig.

Constraints and usage notes

  • The class contains request shape only; routing and validation happen in DocumentApiCall and the downstream service.

Sources

  • Business\SAIF.Business.Policy.Audit.ApiCalls\DistributionRequest.cs