ForSURE.web.downloads

baseURL = '/download'

Base URL for all requests

POST {baseURL}/report/
async def download_report()

Download the specified report.

Parameters

report_name: Name of the report
inprogress: Whether the report is still in progress or the timeframe is in the past.

Returns

File download

POST {baseURL}/reports/
async def get_stat_reports()

Get the list of reports that are already created given the selected optional filters.

Parameters

country: Country of the reports
start_time: Start date of the reporting timeframe
end_time: End date of the reporting timeframe
report_name: Name of the report

Returns

Successful response

    {
        "DE": {
            "EPR_Report_Packaging_DE_21.02.2024-15.03.2024": {
                "Debugger": {
                    "reportname": "Debugger_EPR_Report_Packaging_DE_21.02.2024-15.03.2024",
                    "warning": {}
                },
                "filename": {
                    "reportname": "EPR_Report_Packaging_DE_21.02.2024-15.03.2024",
                    "warning": {}
                }
            }
        }
    }

POST {baseURL}/reports/inprogress
async def get_stat_reports_inprogress()

Get the list of reports that are already created given the selected optional filters.

Parameters

country: Country of the reports
start_time: Start date of the reporting timeframe
end_time: End date of the reporting timeframe
report_name: Name of the report

Returns

Successful response

    {
        "DE": {
            "InProgress_Packaging_DE_01.01.2024-31.12.2024": {
                "filename": {
                    "reportname": "InProgress_Packaging_DE_01.01.2024-31.12.2024",
                    "warning": {}
                },
                "Debugger": {
                    "reportname": "Debugger_InProgress_Packaging_DE_01.01.2024-31.12.2024",
                    "warning": {}
                }
            }
        }
    }

POST {baseURL}/multiple-reports
async def download_reports()

Download multiple reports as a ZIP archive.

Parameters

inprogress: Whether the report is still in progress or the timeframe is in the past.
report_names: List of report_names

Returns

Zip file download

POST {baseURL}/create-download-link
async def create_link()

Create a download link that can be shared with others.

Parameters

inprogress: Whether the report is still in progress or the timeframe is in the past.
report_name: Name of the report

Returns

Successful response

    {
        "link": f"download/{unique_id}",
        "username": "username",
        "password": "password",
        "reportname": "report_name"
    }

POST {baseURL}/{unique_id}
async def download_file()

Access and download the report shared using create_link(). Requires authentication with the generated username and password

Returns

File download