|
|
|
|
|
Processen die documenten of rapporten genereren buiten de Scenario-WebAPI om, kunnen het resultaat van die generatie nu op een vaste manier terugmelden. Daarvoor zijn drie ingangen toegevoegd aan de documentgeneratie-API:
URL |
Toelichting |
|---|---|
PUT document/api/v1/docgen/generatie/zetbezig |
Meldt dat een documentgeneratie bezig is. |
PUT document/api/v1/docgen/generatie/zetmislukt |
Meldt dat een documentgeneratie is mislukt, inclusief foutinformatie. |
POST document/api/v1/docgen/generatie/zetdocument?generatieid={generatieid} |
Levert het gegenereerde document aan. |
Alle drie de ingangen werken op basis van het generatie-id dat aan het generatieproces is meegegeven.
Een mislukte generatie melden
Bij zetmislukt geef je naast het generatie-id een ResourceId mee. Dat is verplicht en zorgt ervoor dat je de aanroep kunt herhalen zonder dat de fout dubbel wordt verwerkt.
Daarnaast geef je de foutgegevens mee:
Veld |
Toelichting |
|---|---|
Foutdomein |
Systeembeheer of Applicatiebeheer. Geef je niets op, dan wordt het Systeembeheer. |
Foutmelding |
Korte, leesbare tekst voor de gebruiker. Langer dan 254 tekens wordt afgekapt, zonder melding aan de aanroeper. Houd de tekst dus kort en gericht op de eindgebruiker. |
Foutinformatie |
Uitgebreide toelichting voor de applicatie- of netwerkbeheerder. |
De uitgebreide foutinformatie blijft minimaal vier dagen beschikbaar. Daarna wordt die opgeruimd en levert het opvragen ervan de tekst "Het log is verwijderd. Er is geen verdere foutinformatie beschikbaar." Onderzoek een mislukte generatie dus binnen die termijn.
Het gegenereerde document aanleveren
Bij zetdocument geef je het generatie-id mee als query-parameter. Het document zelf gaat als bestandsupload mee in de body, inclusief de bestandsnaam. Een gewone JSON-body wordt afgewezen.
De bestandsnaam is verplicht: uit de extensie wordt het documenttype afgeleid, bijvoorbeeld PDF of DOCX. Ontbreekt de extensie of is die onbruikbaar, dan wordt het document niet geaccepteerd.
Geldigheid van het generatie-id
Het generatie-id is vluchtig. Zodra de generatie is afgesloten, geslaagd of mislukt, vervalt het. Voor een volgende generatie moet de container eerst worden gereset. Bij een aanroep op een id dat niet meer bruikbaar is, krijg je een Bad Request met een van deze foutcodes:
Foutcode |
Situatie |
|---|---|
BestaatNiet |
Het generatie-id is vervallen of heeft nooit bestaan. Deze twee situaties zijn voor de aanroeper niet te onderscheiden. |
OpmaakStatusOngeldig |
Het generatie-id is nog geldig, maar de generatie is al afgerond. |
Opslag van de documenten
De gegenereerde documenten worden bewaard in de nieuwe map Dossier\DGCons\Verlopend. Deze map wordt automatisch aangemaakt en is opgenomen in de diagnose op het bestandssysteem.
Impact voor jou
Er zijn alleen ingangen en foutcodes toegevoegd; bestaand gedrag en bestaande contracten zijn ongewijzigd. Voor eindgebruikers verandert er niets. Deze uitbreiding is bedoeld voor processen die documentgeneratie buiten de Scenario-WebAPI om uitvoeren en het resultaat willen terugmelden.