Inhoud

Status opvragen financieel rapport

Method GET

URL {prefix}/uitpas/report/financialoverview/organiser/{statusReportId}/status waarbij {statusReportId} de id is van het status rapport

Parameters:

Naam Type Omschrijving Verplicht
balieConsumerKey String ConsumerKey van de balie waarvoor deze request wordt uitgevoerd. Deze parameter is niet verplicht. Standaard wordt de consumer key uit de oauth request gebruikt. Zie gebruik van andere balies door Service Consumer in punt 2.4  

Authenticatie User access token van de balie medewerker die de actie uitvoert

Response

Bij succes HTTP 200 met een response body in XML formaat:

code ACTION_SUCCEEDED
message wanneer generatie nog bezig is: Export in progress.
wanneer generatie klaar is: Export completed.
resource wanneer generatie nog bezig is: URL om de status van het gestarte rapport op te vragen: {prefix}/uitpas/report/financialoverview/organiser/{REPORT_ID}/status
wanneer generatie klaar is: URL om het rapport te downloaden: {prefix}/uitpas/report/financialoverview/organiser/{REPORT_ID}/download
Indien de balieConsumerKey werd meegegeven, zal deze ook in de resource url gezet worden.

Bij fouten HTTP 400 met een response body in XML formaat:

code ErrorCode van de fout:
UNKNOWN_BALIE_CONSUMERKEY
ACCESS_DENIED
UNKNOWN_REPORT_ID
ACTION_FAILED
message Beschrijving van de fout

Voorbeeld request

GET {prefix}/uitpas/report/financialoverview/organiser/19/status?balieConsumerKey=57588868-EA2A-3A56-0AC173415A6D1BE7

Voorbeeld response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
    <code>ACTION_SUCCEEDED</code>
    <message>Export completed.</message>
    <resource>/uitpas/report/financialoverview/organiser/19/download?consumerKey=57588868-EA2A-3A56-0AC173415A6D1BE7</resource>
</response>

Lees vorige:
Financieel rapport aanmaken

 

Lees verder:
Download financieel rapport