GRB MELDING SYSTEEM WEBDIENST. Functionele documentatie. Versie /// 1.0 Publicatiedatum /// 26/05/2016. /// Handleiding

Transcriptie

1 /// Handleiding GRB MELDING SYSTEEM WEBDIENST Functionele documentatie Versie /// 1.0 Publicatiedatum /// 26/05/2016

2 Informatie Vlaanderen /// Auteur: Carolien Willen Datum aanmaak: 25 mei 2016 Datum afdruk: 27 mei 2016 Interne bestandsnaam: mcw _grbms Webdienst Functionele Documentatie_Productie_v1.0.docx Documenthistoriek: Versie Opmerking Datum Auteur Status 1.0 Aanmaak documentatie 25/05/2016 Carolien Willen Gepubliceerd Informatie Vlaanderen Hoofdzetel Boudewijnlaan 30, 1000 Brussel +32 (0) Regionale zetel Koningin Maria Hendrikaplein 70, 9000 Gent +32 (0) /// /// GRB Melding Systeem Webdienst Productie

3 /// Informatie Vlaanderen INHOUD Inhoud Context GRBMS Webdienst bèta en productie Testen via de bèta GRBMS webdienst API Vraag per mail toegang aan voor de bèta omgeving Leer hoe je een met WS-Federation beveiligde service aanroept Opvolging van je testmeldingen Overstappen naar de productie omgeving Wat kan de GRBMS webdienst je aanbieden? Meld GRB-afwijking(en) aan Informatie Vlaanderen Vraag een lijst op van jouw GRB-meldingen Vraag een lijst op van jouw GRB-afwijkingen binnen een specifieke GRB-melding Wat betekenen deze velden? Melding Id Meldingstatus Meldingtype Aangemaakt Gewijzigd Aantal afwijkingen Aantal kandidaatafwijkingen Idn Datum beschrijving Datum vaststelling Oorzaak Afwijking status Afwijking validatiestatus Afwijking integratiestatus Voorbeeldscenario Doorgeven van GRB-afwijkingen aan Informatie Vlaanderen De meldingen van je organisatie opvragen De afwijkingen van een bepaalde melding van je organisatie opvragen GRB Melding Systeem Webdienst Productie /// /// 18

4 Informatie Vlaanderen /// 1 CONTEXT Met de GRB Melding Systeem webdienst API kan je het GRB Melding Systeem integreren en koppelen met je eigen systemen. Je kan er GRB-afwijkingen mee melden aan Informatie Vlaanderen en informatie over je meldingen en bijhorende afwijkingen mee beheren. De GRBMS webdienst API gebruikt Soap 1.2 voor de uitwisseling van informatie en is beveiligd via WS- Federation. 2 GRBMS WEBDIENST BÈTA EN PRODUCTIE GRBMS heeft twee omgevingen, een productie omgeving en een bèta omgeving. Deze twee omgevingen zijn volledig van elkaar gescheiden. De bèta omgeving maakt gebruik van de bèta security omgeving. 2.1 TESTEN VIA DE BÈTA GRBMS WEBDIENST API Vraag per mail toegang aan voor de bèta omgeving Nieuwe integraties met de GRBMS webdienst zijn enkel toegelaten via een certificaat. De procedure verloopt standaard als volgt: a. Mail naar contactpunt@agiv.be met als onderwerp Testen GRBMS webdienst. b. In bijlage: een niet self-signed certificaat in zip-formaat, zonder private key. c. Geef aan welke organisatie en welk adres gekoppeld moeten worden aan dit certificaat. d. Wij installeren het certificaat in bèta, en van daaruit kunnen de integratietesten starten Leer hoe je een met WS-Federation beveiligde service aanroept We hebben hiervoor twee frameworks gebouwd die het proces vergemakkelijken. Eén voor.net en één voor JAVA. Je vindt alle informatie op Je kan er ook de frameworks downloaden. Heb je nog vragen? Contacteer dan het GeoSecure team (contactpunt@agiv.be) Opvolging van je testmeldingen De GRBMS webdienst laat je ook toe om de verdere verwerking van jouw melding op te volgen. Daartoe controleert Informatie Vlaanderen best jouw testmeldingen en de erin opgenomen GRB-afwijkingen om de verschillende statussen te kunnen bevragen. Dit gebeurt echter niet automatisch, je moet dit aanvragen: a. Mail naar contactpunt@agiv.be met als onderwerp Validatie Test GRBMS webdienst 4 /// /// GRB Melding Systeem Webdienst Productie

5 /// Informatie Vlaanderen b. Vermeld in dit bericht de melding ID s van de meldingen die je verwerkt wil zien. De afwijkingen binnen deze meldingen zullen ad random gevalideerd worden. Het contactpunt zal je verwittigen wanneer de melding verwerkt is. 2.2 OVERSTAPPEN NAAR PRODUCTIE GRBMS WEBDIENST API Vraag per mail toegang aan voor de productie omgeving Heb je een applicatie ontwikkeld tegen de bèta omgeving en wil je in productie gaan dan heb je een productie account nodig: a. Mail naar contactpunt@agiv.be met als onderwerp Productie GRBMS webdienst. b. In bijlage: een niet self-signed certificaat in zip-formaat, zonder private key. Je hebt 2 opties: i. Je draagt het certificaat over dat je voor de testen in de bèta omgeving hebt gebruikt. Daardoor vervalt jouw toegang voor de bèta omgeving. ii. Je levert een nieuw certificaat. Daardoor behoud je de toegang tot de bèta omgeving. c. Geef aan welke organisatie en welk adres gekoppeld moeten worden aan dit certificaat. d. Wij installeren het certificaat in productie. 2.3 WAT KAN DE GRBMS WEBDIENST JE AANBIEDEN? Meld GRB-afwijking(en) aan Informatie Vlaanderen Via de methode MeldGrbAfwijking kan je GRB-afwijkingen melden. Volgende velden moeten doorgegeven worden per afwijking binnen een melding: Idn Datum beschrijving Datum vaststelling Oorzaak Srid De afwijkingen moeten correct beschreven zijn zoals terug te vinden is in de Handleiding voor het melden van GRB-afwijkingen. De melding ondergaat automatisch een eerste controle. Bij een correcte melding geeft de webdienst de Melding Id terug. Bij fouten in de melding geeft de service een foutmelding terug. Uit de foutmelding zal je kunnen afleiden in welke afwijking een fout aanwezig is en wat er niet correct is. GRB Melding Systeem Webdienst Productie /// /// 18

6 Informatie Vlaanderen /// Vraag een lijst op van jouw GRB-meldingen Via de methode LijstMeldingen kan je een lijst van meldingen van je organisatie opvragen. Bij het opvragen van de lijst kan je kiezen voor een aantal optionele filters: Aangemaakt: Filter voor de periode waarin de melding aangemaakt is Gewijzigd: Filter voor de periode waarin de melding laatst gewijzigd is Melding Id: Filter voor de Id van de melding Melding Type: Filter voor het type van de melding Melding Status: Filter voor de status van de melding De webdienst geeft voor elke melding volgende velden terug: Melding Id Melding Status Melding Type Aangemaakt Gewijzigd Aantal Afwijkingen Aantal Kandidaatafwijkingen Vraag een lijst op van jouw GRB-afwijkingen binnen een specifieke GRB-melding Via de methode LijstAfwijkingen kan je een lijst van afwijkingen van een specifieke melding van je organisatie opvragen. Bij het opvragen van de lijst kan je kiezen voor een aantal optionele filters: Datum beschrijving: Filter voor de periode waarin de afwijking beschreven is Datum vaststelling: Filter voor de periode waarin de afwijking vastgesteld is Afwijking status: Filter voor de status van een afwijking Afwijking integratiestatus: Filter voor de integratiestatus van een afwijking Afwijking validatiestatus: Filter voor de validatiestatus van een afwijking De webdienst geeft voor elke afwijking volgende velden terug: Idn Aangemaakt Gewijzigd Datum beschrijving Datum vaststelling Oorzaak Afwijking status 6 /// /// GRB Melding Systeem Webdienst Productie

7 /// Informatie Vlaanderen Afwijking validatiestatus Afwijking integratiestatus 2.4 WAT BETEKENEN DEZE VELDEN? Melding Id Id van de melding. Dit is een uniek volgnummer dat automatisch wordt toegekend door Informatie Vlaanderen aan elke correct ontvangen melding Meldingstatus Deze status bij een melding geeft weer in welke fase van behandeling de melding zich bevindt. Informatie Vlaanderen beschikt over 30 dagen om de melding te controleren. Waarde TeControleren InBehandelingOntgrendeld InBehandelingVergrendeld Verwerkt Omschrijving De melding is te controleren. De melding is in behandeling en ontgrendeld. Een deel van de afwijkingen binnen de melding zijn reeds gecontroleerd, de melding wordt op dit moment niet verder gecontroleerd. De melding is in behandeling en vergrendeld. De afwijkingen binnen de melding worden op dit moment gecontroleerd. De melding is verwerkt (controle is afgewerkt) Meldingtype Tabel 1: Meldingstatus Het type van de melding, dit is hoe de melding bij Informatie Vlaanderen is terecht gekomen. Het melding type wordt automatisch door Informatie Vlaanderen toegekend. GRB Melding Systeem Webdienst Productie /// /// 18

8 Informatie Vlaanderen /// Waarde Website Upload Service Omschrijving De melding is aangemaakt via de online applicatie van de website. De melding is aangemaakt via de upload module van de website. De melding is aangemaakt via de webdienst Aangemaakt Tabel 2: Meldingtype De datum en het tijdstip waarop de melding of afwijking aangemaakt werd Gewijzigd De datum en het tijdstip waarop de melding of afwijking laatst gewijzigd werd Aantal afwijkingen Het aantal afwijkingen in de melding Aantal kandidaatafwijkingen Het aantal kandidaatafwijkingen 1 in de melding Idn Het uniek volgnummer (groter dan 0) van de afwijking binnen éénzelfde melding Datum beschrijving De datum waarop de afwijking beschreven werd. Zie hiervoor ook hoofdstuk 2 in de Handleiding voor het melden van GRB-afwijkingen Datum vaststelling De datum waarop de afwijking werd vastgesteld. Deze komt overeen met de datum van beëindiging van de werken, of indien deze niet gekend is komt hij overeen met de datum waarop de afwijking voor het eerst werd vastgesteld. Zie hiervoor ook hoofdstuk 2 in de Handleiding voor het melden van GRB-afwijkingen. 1 Een kandidaatafwijking kan enkel ontstaan bij melden via de Upload methode. Een kandidaatafwijking is een afwijking waarin een kleine fout zit (opbouw van de afwijking of geometrie) die doorgelaten wordt bij de validatie tegen het GRBMS XSD-schema. Kandidaatafwijkingen worden gecorrigeerd door Informatie Vlaanderen tot correcte afwijkingen. Gezien het wel degelijk om een foutieve afwijking gaat zijn kandidaatafwijkingen niet gewenst. 8 /// /// GRB Melding Systeem Webdienst Productie

9 /// Informatie Vlaanderen Oorzaak Dit attribuut beschrijft de oorzaak van de afwijking. De oorzaak kan volgende waarden hebben: 1, 2, 3, 4, 5, 6, 10, 11, 12, 13, 14, 15, 16, 99. Een omschrijving van de juiste betekenis voor elk type oorzaak afwijking vind je in bijlage 1 van de Handleiding voor het melden van GRB-afwijkingen Een detailbeschrijving over de oorzaak van de afwijking. De verduidelijking moet voldoen aan de syntaxregels zoals beschreven in bijlage 3 van de Handleiding voor het melden van GRB-afwijkingen Eén enkele polygoon in well known tekst formaat (geometrie van de afwijking). De geometrie moet opgesteld zijn in Lambert 72 en liggen in het grondgebied Vlaanderen. De polygoon is niet kleiner dan 3 m² en niet groter dan m². De polygoon mag niet zelfsnijdend zijn Geeft de beschikbaarheid van een as-builtplan weer. Meer informatie over as-builtplannen en de verplichtingen er rond vind je hier. Waarde Unknown AsBuiltPlanAccordingToGRBCoreDefinitions AsBuiltPlanAccordingToGRBBase NoAsBuiltPlan Omschrijving De beschikbaarheid van een as-builtplan is niet gekend Er is (zal) een as-builtplan volgens de oude specificaties (GRB-kernbepalingen) beschikbaar (zijn) Er is (zal) een as-builtplan volgens de nieuwe specificaties (GRB-basis) beschikbaar (zijn) Er is geen as-builtplan Afwijking status Tabel 3: Deze status bij een afwijking geeft weer in welke fase van behandeling de afwijking zich bevindt. Informatie Vlaanderen beschikt over 30 dagen om de afwijking te controleren. Waarde TeControleren InBehandeling Verwerkt Tabel 4: Afwijking status Omschrijving De afwijking is te controleren. De afwijking is in behandeling (wordt gecontroleerd). De afwijking is verwerkt (controle is afgewerkt). GRB Melding Systeem Webdienst Productie /// /// 18

10 Informatie Vlaanderen /// Afwijking validatiestatus Deze status bij een afwijking geeft weer of een afwijking al dan niet gevalideerd is. Een gevalideerde afwijking wordt als anomalie geïntegreerd in het GRB-product. Waarde NietGevalideerd Gevalideerd GevalideerdGoedgekeurdeVergunningen GevalideerdAchtergrondInformatie GevalideerdTwijfelgeval GevalideerdKadaster GevalideerdGRBKwaliteitscontrole Afwijking integratiestatus Tabel 5: Afwijking validatiestatus Omschrijving De afwijking is (nog) niet gevalideerd. De afwijking is gevalideerd en actueel. De afwijking is gevalideerd, vermoedelijk actueel op basis van goedgekeurde vergunningen. De afwijking is gevalideerd en vermoedelijk actueel op basis van onvolledige achtergrondinformatie De afwijking is gevalideerd, het betreft een twijfelgeval (CRAB-Validatie) De afwijking is gevalideerd en vermoedelijk terecht op basis van de kadastrale plannen De afwijking is gevalideerd en vermoedelijk actueel op basis van de GRB-kwaliteitscontrole met onvolledige informatie Deze status bij een afwijking geeft weer of een afwijking al dan niet geïntegreerd is als anomalie in het GRBproduct. Een anomalie is een geverifieerde GRB-afwijking. Tussen de integratie van een GRB-afwijking en opname als anomalie in het GRB-product zit een dag verschil. Waarde TeIntegreren Geintegreerd ProbleemBijIntegratie Omschrijving Tabel 6: Afwijking integratiestatus De afwijking moet nog geïntegreerd worden. De afwijking is succesvol geïntegreerd. De overeenstemmende anomalie is een dag na de integratie te raadplegen. De afwijking had een probleem bij de integratie. 10 /// /// GRB Melding Systeem Webdienst Productie

11 /// Informatie Vlaanderen 2.5 VOORBEELDSCENARIO Hieronder kan je een voorbeeld met mogelijk te volgen stappen vinden om het geheel wat meer te duiden Doorgeven van GRB-afwijkingen aan Informatie Vlaanderen Stel je tekent in een applicatie van je eigen organisatie een aantal GRB-afwijkingen in. Je vult volgende attributen correct in: Oorzaak Datum vaststelling Datum beschrijving Je wenst deze afwijkingen ter validatie door te geven aan Informatie Vlaanderen op 11/02/2016. De applicatie bundelt de afwijkingen in één melding, elke afwijking wordt voorzien van een uniek volgnummer (Idn). Via de methode MeldGrbAfwijking van de GRBMS webdienst wordt de melding aan Informatie Vlaanderen bezorgt. De melding bevat vb. volgende afwijkingen: Afwijking 1 Srid Idn 1 Oorzaak 5 entiteit wri type cirkelvormig putdeksel nieuw aanleg rio met zichtbare putdeksel Datum vaststelling Datum beschrijving Unknown GEOMETRYCOLLECTION(POLYGON(( , , , , , , , , GRB Melding Systeem Webdienst Productie /// /// 18

12 Informatie Vlaanderen /// Afwijking 2 Srid Idn 2 Oorzaak 1 Datum vaststelling Datum beschrijving Afwijking , , , , ))) entiteit gbg geometrie foutieve vorm het gebouw is onvolledig opgemeten; de vorm is vervolledigd met constructiegevels Unknown Srid Idn 3 Oorzaak 6 Datum vaststelling Datum beschrijving GEOMETRYCOLLECTION(POLYGON(( , , , , ))) entiteit wgo type grens onverharde zone gewijzigd werken bezig AsBuiltPlanAccordingToGRBBase GEOMETRYCOLLECTION(POLYGON(( , , , /// /// GRB Melding Systeem Webdienst Productie

13 /// Informatie Vlaanderen , ))) Afwijking 4 Srid Idn 4 Oorzaak 12 nieuwbouw hoofdgebouw Datum vaststelling Datum beschrijving Unknown GEOMETRYCOLLECTION(POLYGON(( , , , , , ))) Tabel 7: voorbeeld Meld GRB-afwijkingen Indien de melding correct gebeurt zal de webdienst de id van deze melding terug geven. Op basis van deze Id zal je in een volgende stap bevragingen kunnen doen aan de webdienst. Stel dat de verduidelijking van afwijking 3 van bovenstaande melding er als volgt uit zag: entiteit wgo type grens onverharde zone heraangelegd werken bezig Tabel 8: Voorbeeld foutieve syntax In deze verduidelijking wordt een fout gemaakt tegen de syntaxregel: heraangelegd bestaat niet als vastgestelde wijziging. Stuur je dergelijke melding door dan geeft de webdienst volgende foutmelding terug: Afwijking 3: verduidelijking voldoet niet aan de validatieregel. Raadpleeg de handleiding voor de validatieregel bij de betreffende oorzaak. Op basis van deze foutmelding kan je de verduidelijking van afwijking 3 gaan corrigeren De meldingen van je organisatie opvragen Stel verschillende personen binnen je organisatie hebben meldingen doorgegeven aan Informatie Vlaanderen en dit eventueel op verschillende manieren (via de online webapplicatie, via de upload, vanuit een eigen applicatie die verbonden is met de webdienst). Via de methode LijstMeldingen kan je nu de meldingen en het bijhorend aantal afwijkingen van je organisatie gaan opvragen, eventueel gefilterd. GRB Melding Systeem Webdienst Productie /// /// 18

14 Informatie Vlaanderen /// Voorbeeld 1: je wenst een lijst van alle meldingen van je organisatie die gedurende een bepaalde maand gemaakt werden via de webdienst. Dan moet je volgende parameters doorgeven: Vraag LijstMeldingen Startpositie 2 0 Aangemaakt 01/01/2016 1/02/2016 Melding type Service Tabel 9: Voorbeeld 1 vraag Lijst meldingen Op deze manier krijg je een zicht op de meldingen van de maand januari die voor je organisatie werden gemeld via de webdienst. Je ziet per melding het aantal afwijkingen, wanneer de melding laatst gewijzigd werd, de Id en de status van de melding. Voorbeeld2: je wenst de status te kennen van je melding uit Je kreeg van de webdienst de Id terug van je correcte melding die je aanleverde aan Informatie Vlaanderen (stel 13154). Dan geef je volgende parameters door: Vraag LijstMeldingen Startpositie 3 0 Melding Id Tabel 10: Voorbeeld 2 vraag Lijst meldingen 2 De webdienst geeft standaard 50 resultaten terug. Indien er meer dan 50 meldingen zijn wordt dit aangegeven. De startpositie moet aangepast worden naargelang het totaal aantal meldingen die voldoen aan je vraag. 3 De webdienst geeft standaard 50 resultaten terug. Indien er meer dan 50 meldingen zijn wordt dit aangegeven. De startpositie moet aangepast worden naargelang het totaal aantal meldingen die voldoen aan je vraag. 14 /// /// GRB Melding Systeem Webdienst Productie

15 /// Informatie Vlaanderen Stel dat de melding nog niet werd behandeld door Informatie Vlaanderen dan zal de webdienst je volgende gegevens terug geven: Melding antwoord Melding Id Aangemaakt Gewijzigd T09:50: T09:50:52 Aantal afwijkingen 4 Aantal kandidaatafwijkingen 0 Melding status Melding type TeControleren Service Tabel 11: Voorbeeld antwoord Lijst meldingen Wens je meer informatie over je melding kan je de volgende stap uitvoeren De afwijkingen van een bepaalde melding van je organisatie opvragen Via de methode LijstAfwijkingen kan je nu voor een specifieke melding de bijhorende afwijkingen gaan opvragen, eventueel gefilterd. Hierbij moet je steeds de Melding Id meegeven aan de webdienst. Deze Id ken je uit één van de vorige stappen. Voorbeeld 1: stel je wil de afwijkingen uit je melding van hierboven opvragen. Dan geef je volgende parameters door via de methode LijstAfwijkingen: Vraag LijstAfwijkingen Startpositie 0 Melding Id Tabel 12: Voorbeeld 1 vraag Lijst afwijkingen Stel dat jouw melding op dat moment wordt behandeld door Informatie Vlaanderen zal je volgende gegevens terug krijgen van de webdienst: Afwijking 1 Idn 1 Oorzaak 5 entiteit wri type cirkelvormig putdeksel nieuw aanleg rio met zichtbare putdeksel Datum vaststelling Datum beschrijving GRB Melding Systeem Webdienst Productie /// /// 18

16 Informatie Vlaanderen /// Aangemaakt Gewijzigd Afwijking status Afwijking validatiestatus Afwijking integratiestatus Afwijking T09:50: T10:03:10 InBehandeling Gevalideerd TeIntegreren Unknown Srid Idn 2 Oorzaak 1 Datum vaststelling Datum beschrijving Aangemaakt Gewijzigd Afwijking status Afwijking validatiestatus Afwijking integratiestatus GEOMETRYCOLLECTION(POLYGON(( , , , , , , , , , , , , ))) entiteit gbg geometrie foutieve vorm het gebouw is onvolledig opgemeten; de vorm is vervolledigd met constructiegevels T09:50: T10:03:10 InBehandeling Gevalideerd TeIntegreren Unknown 16 /// /// GRB Melding Systeem Webdienst Productie

17 /// Informatie Vlaanderen Afwijking 3 Srid Idn 3 Oorzaak 6 Datum vaststelling Datum beschrijving Aangemaakt Gewijzigd Afwijking status Afwijking validatiestatus Afwijking integratiestatus Afwijking 4 GEOMETRYCOLLECTION(POLYGON(( , , , , ))) entiteit wgo type grens onverharde zone gewijzigd werken bezig T09:50: T10:03:10 InBehandeling Gevalideerd Srid Idn 4 Oorzaak 12 TeIntegreren Datum vaststelling Datum beschrijving AsBuiltPlanAccordingToGRBBase GEOMETRYCOLLECTION(POLYGON(( , , , , ))) nieuwbouw hoofdgebouw GRB Melding Systeem Webdienst Productie /// /// 18

18 Informatie Vlaanderen /// Aangemaakt Gewijzigd Afwijking status Afwijking validatiestatus Afwijking integratiestatus T09:50: T10:03:10 InBehandeling Gevalideerd TeIntegreren Unknown GEOMETRYCOLLECTION(POLYGON(( , , , , , ))) Tabel 13: Voorbeeld antwoord Lijst afwijkingen Voorbeeld 2: stel je wenst enkel de status te kennen van de afwijkingen binnen je melding die je in 2015 hebt vastgesteld. Dan geef je volgende parameters mee aan de webdienst: Vraag LijstAfwijkingen Startpositie 0 Melding Id Datum vaststelling 01/01/ /01/2016 Tabel 14: Voorbeeld 2 vraag Lijst afwijkingen De webdienst zal je dan enkel de details geven van afwijking 1, afwijking 3 en afwijking 4 omdat deze een vaststellingsdatum hebben in Dit zijn maar enkele voorbeelden van de vele filtermogelijkheden op de methodes LijstMeldingen en LijstAfwijkingen. 18 /// /// GRB Melding Systeem Webdienst Productie