Interface IScraperSessionDocuments
This interface shall be implemented by scrapers that support downloading of PDF account documents.
Namespace: Subsembly.Scraper
Assembly: Subsembly.Scraper.dll
Syntax
public interface IScraperSessionDocumentsRemarks
The methods in this interface may only be invoked after a successful Login(JsonObject).
A scraper that implements this interface shall advertise it through the ImplementsDocuments flag.
Properties
MaxDocumentDays
Provides the max number of history days for which statement data can be downloaded via DownloadDocumentList(out JsonArray, JsonObject, DateTime).
Declaration
int MaxDocumentDays { get; }Property Value
| Type | Description |
|---|---|
| int |
Remarks
By default the PSD2 RTS default value 90 should be assumed.
Methods
DownloadDocument(out byte[], JsonObject, JsonObject)
Download the PDF data for a particular document.
Declaration
ScraperResult DownloadDocument(out byte[] vbPDF, JsonObject jsAcct, JsonObject jsDoc)Parameters
| Type | Name | Description |
|---|---|---|
| byte[] | vbPDF | |
| JsonObject | jsAcct | |
| JsonObject | jsDoc | Specification of the document for which to download the PDF data. The fields must be initialized accoring to SUPA. It is recommended to just pass the JSON object returned by DownloadDocumentList(out JsonArray, JsonObject, DateTime). |
Returns
| Type | Description |
|---|---|
| ScraperResult |
DownloadDocumentList(out JsonArray, JsonObject, DateTime)
Download a list of available PDF documents for an account.
Declaration
ScraperResult DownloadDocumentList(out JsonArray jsDocList, JsonObject jsAcct, DateTime tFromDate)Parameters
| Type | Name | Description |
|---|---|---|
| JsonArray | jsDocList | Array of JSON objects with PDf document details according to the SUPA specification. |
| JsonObject | jsAcct | |
| DateTime | tFromDate | The starting date from which documents should be returned, up to today. If this is
|
Returns
| Type | Description |
|---|---|
| ScraperResult |