84c0a54c1e
Updated `DocumentEndpoints` to include detailed requirements, return values, and use case for the `ExtractSwissQrCode` endpoint. Marked Feature 2 (`ExtractSwissQrCode`) as completed in `PHASENPLAN.md` and `ROADMAP.md`, summarizing achievements and outlining next steps for Feature 3 (`ExtractAttachments`). Enhanced `ExtractSwissQrCodeRequest` and `ExtractSwissQrCodeResponse` DTOs with example JSON payloads for clarity. Expanded `SwissQrCodeDataDto` and `AddressDataDto` with detailed field-level documentation to improve usability and adherence to Swiss QR Bill Standard 2.0.
19 lines
601 B
C#
19 lines
601 B
C#
namespace DocumentOperator.Application.Common.DTOs;
|
|
|
|
/// <summary>
|
|
/// Request to extract Swiss QR Code from a PDF document.
|
|
/// The QR code must be located on the last page of the document.
|
|
/// </summary>
|
|
/// <param name="References">Array of reference strings to pass through in the response</param>
|
|
/// <param name="Base64Pdf">PDF document encoded as Base64 string</param>
|
|
/// <example>
|
|
/// {
|
|
/// "references": ["REF-001", "REF-002"],
|
|
/// "base64Pdf": "JVBERi0xLjQK..."
|
|
/// }
|
|
/// </example>
|
|
public record ExtractSwissQrCodeRequest(
|
|
IReadOnlyList<string> References,
|
|
string Base64Pdf
|
|
);
|