Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Algemeen
Het antwoord wordt in een CSV bestandsformaat doorgegeven. Elke lijn bevat 1 antwoord waarin aangegeven wordt of een registratie geslaagd is, niet geslaagd is en eventueel een uitzondering wordt meegegeven.
De referte in het antwoord is dezelfde als deze in de vraag. Via de referte kunnen vraag en antwoord aan mekaar gekoppeld worden. In het uitzonderlijk geval dat een vraag-bestand niet correct kan verwerkt worden zal een uitzondering worden doorgegeven zonder referte. In dit geval kan de referte uit de bestandsnaam gebruikt worden om het vraag- aan het resultaat-bestand aan mekaar te koppelen.
Hieronder een overzicht van de dataflow die op deze pagina behandeld wordt
| Drawio | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CSV output formaat
Het bestand voldoet aan al volgende richtlijnen
- Encoding is UTP-8ISO-8859-1 encoding
Geen header rij. De eerste rij bevat effectieve gegevens
De volgorde van de velden voldoet aan onderstaande lijst
De velden worden afgebakend met dubbele aanhalingstekens (")
De velden worden gescheiden door een punt-komma (;)
Lege velden worden steeds weergegeven door twee opeenvolgende dubbele aanhalingstekens. Velden worden nooit weggelaten
Geen line feed na de laatste datalijn, bestand eindigt m.a.w. bij het laatste karakter van de laatste datalijn
Bestandsnaam
De bestandsnaam is zo goed als identiek aan de bestandsnaam die gebruikt is om de vragen door te sturen. Er wordt echter voor de extensie "_Resultaat" toegevoegd.
<Prefix>_<Naam LEZ inrichter>_<Naam Magda BD> _<Referte UUID>_<Tijdstip aanmaak bestand>_Resultaat.<Extensie>
De verschillende onderdelen worden geaggregeerd met een underscore (_).
Gegeven | Omschrijving | Voorbeeld |
|---|---|---|
Prefix | Verwijzing naar Lage Emissie Zone, steeds “LEZ” | LEZ |
Naam LEZ inrichter | Naam van de LEZ inrichter. Kan dus Antwerpen of Gent zijn op dit moment | Antwerpen |
Naam Magda BD | Naam van de dienst die na FTF moet worden aangeroepen | RegistreerLEZGegevens |
Referte UUID | Unieke referte van de aangeleverde lijst, 128-bit, 36 tekens, structuur 8-4-4-4-12 | 78852dd8-69d2-11e6-8b77-86f30ca893d3 |
Tijdstip aanmaak bestand | Datum en tijdstip van aanmaak bestand, formaat YYYYMMDDHHMMSSSSS | 20190324081035123 |
| Resultaat | Vaste string om aan te duiden dat het een resultaat-bestand betreft | "Resultaat" |
Extensie | Extensie waarmee het bronbestand wordt aangeleverd | csv |
Voorbeeld
LEZ_Antwerpen_RegistreerLEZGegevens_78852dd8-69d2-11e6-8b77-86f30ca893d3_20190324081035123_Resultaat.csv
Detail
Alle datums in onderstaande lijst worden opgegeven in het formaat jjjj-mm-dd (vb. 2019-05-01)
| Volg Nr | Naar CSV | Verdere toelichting |
|---|---|---|
| 1 | Referte | Referentie uit de vraag |
| 2 | ResultaatCode | Logische waarde die aangeeft of de registratie gestaagd is |
| 3 | ResultaatBeschrijving | Beschrijving van het resultaat 1 : Wel Geslaagd |
| 4 | UitzonderingCode | Code van de uitzondering |
| 5 | UitzondernigOorsprong | Oorsprong van de uitzondering |
| 6 | UitzonderingType | Type uitzondering (FOUT, INFORMATIE of WAARSCHUWING) |
| 7 | UitzonderingDatum | Datum waarop de uitzondering is voorgevallen |
| 8 | UitzonderingTijd | Tijdstip waarop de uitzondering is voorgevallen |
| 9 | UitzonderingOmschrijving | Diagnose van de uitzondering |
| 10 | AnnotatieNaam | Naam van de annotatie |
| 11 | AnnotatieWaarde | Waarde van de annotatie |
Uitzonderingen
Daar de DISP Scheduler verschillende SOAP calls maakt naar de /wiki/spaces/MDI/pages/838238514 dienst is het mogelijk dat Uitzonderingen op verschillende niveaus terugkomen.
Uitzondering op het SOAP of Repliek niveau worden eerst teruggegeven. Hiervoor wordt een lijn aangemaakt in het Resultaat document waarbij enkel de Uitzondering en eventueel Annotatie velden worden ingevuld.
Uitzonderingen in het Antwoord en de eventueel bijhorende annotatie worden doorgegeven in de daarvoor voorziene velden, samen met de bijhorende datavelden.
Er zijn geen bijkomende dienst-specifieke uitzonderingen die in dit deel van de flow worden gedefinieerd. Generieke uitzonderingen zoals gestipuleerd op Werking en overzicht Overzicht uitzonderingen MAGDA 2.0 Webserviceswebservices zijn natuurlijk van toepassing.
Voorbeelden
CSV output zonder fout
| Code Block | ||||
|---|---|---|---|---|
| ||||
"Vraagreferte van de afnemer";"1";"Wel geslaagd";"";"";"";"";"";"";"";"" |
CSV output met fout is bestand-niveau
Dit soort fout wordt gegenereerd als het CSV bestand niet kan verwerkt worden.
| Code Block | ||||
|---|---|---|---|---|
| ||||
"";"";"";"10050";"MAGDA";"FOUT";"2019-05-10";"20:00:05:001";"CSV importeer fout";"";"" |
CSV output met uitzondering op Repliek niveau
Een fout op repliek niveau wordt gegeven als MAGDA de vraag niet kan verwerken. Meestal gebeurt dit bij validatie van de vraag.
| Code Block | ||||
|---|---|---|---|---|
| ||||
"";"";"";"13102";"MAGDA";"FOUT";"2019-05-10";"20:00:05:001";"Een vraagelement bevat een niet toegelaten waarde";"";"" |
CSV output met uitzondering in Antwoord
Een fout op Antwoord niveau wordt gegeven als de bron de vraag niet kan verwerken of er geen connectie met de bron kan gemaakt worden.
| Code Block | ||||
|---|---|---|---|---|
| ||||
"Vraagreferte van de afnemer";"0";"Niet geslaagd";"99987";"MAGDA";"FOUT";"2019-05-10";"20:00:05:001";"Geen authorisatie";"";"" |
Op deze pagina
| Table of Contents | ||
|---|---|---|
|
Binnen deze handleiding
| Page Tree | ||
|---|---|---|
|