|
|
(194 tussenliggende versies door dezelfde gebruiker niet weergegeven) |
Regel 1: |
Regel 1: |
| __TOC__ | | __TOC__ |
− |
| |
| = Algemeen = | | = Algemeen = |
− | De volgende koppelingen kunnen beheerd worden vanuit het zaaksysteem:<br>
| + | Binnen zaaksysteem.nl is er een generiek koppelplatform met koppelprofielen.. een koppelprofiel bevat logica en mogelijkheden om de koppeling te beheren. Koppelingen die ontwikkeld worden voor organisaties die gebruik maken van het zaaksysteem, worden als koppelprofiel toegevoegd. Dit betekent dat ze vanaf dat moment ook beschikbaar zijn voor andere organisaties. Hoewel het organisaties geheel vrij staat om nieuwe koppelingen in te richten op basis van een koppelprofiel, is er bij veel koppelingen specifieke kennis nodig voor het werkend opleveren van de koppeling. Wij adviseren dan ook om contact op te nemen met Mintlab voor eventuele ondersteuning. |
− | <ul>
| |
− | <li>BAG import via CSV</li>
| |
− | <li>Key2Finance</li>
| |
− | <li>Key2Burgerzaken</li>
| |
− | <li>StUF Koppeling Configuratie</li>
| |
− | <li>StUF Koppeling (PRS)</li>
| |
− | <li>StUF Koppeling (NNP)</li>
| |
− | <li>StUF Koppeling (ADR)</li>
| |
− | <li>StUF Koppeling (VBO)</li>
| |
− | </ul>
| |
− | === Transactieoverzicht ===
| |
− | In dit overzicht worden alle transacties en basisgegevens weergegeven. Er kan gefilterd worden per koppeling en op fouten, zodat de beheerder eventuele problemen snel kan ontdekken en actie ondernemen. Door op de transactie te klikken kan deze in meer detail worden bekeken.<br>
| |
| | | |
− | === Configuratiescherm ===
| + | Het onderdeel 'koppelingen' bestaat uit de volgende drie overzichten: |
− | Op het configuratiescherm worden de instellingen van de koppelingen beheerd en kunnen nieuwe koppelingen worden aangemaakt.
| |
− | | |
− | Instellingen die elke koppeling heeft zijn:<br>
| |
| <ul> | | <ul> |
− | <li>API</li> | + | <li>[[Transactieoverzicht|Transactieoverzicht]]</li> |
− | <li>Zaaktype</li> | + | <li>[[Koppelingconfiguratie|Koppelingconfiguratie]]</li> |
− | <li>Gegevensmapping</li> | + | <li>[[Gegevensmagazijn|Gegevensmagazijn]]</li> |
− | <li>Status (actief / niet actief)</li>
| |
| </ul> | | </ul> |
| | | |
− | === Afnemerindicaties === | + | = Lijst van koppelingen = |
− | &&&aanvullen<br>
| |
− | <br>
| |
| | | |
− | === Screenshots === | + | {| class="wikitable sortable" border="1" |
− | <gallery widths=200px heights=200px>
| + | |+ - Koppelingen - |
− | File:Koppelingen transactieoverzicht.png|Transactieoverzicht
| + | |- |
− | File:Koppelingen configuratiescherm.png|Configuratiescherm
| + | ! scope="col" class="sortable" width="170pt"| Naam |
− | File:Koppelingen afnemerindicaties.png|Afnemerindicaties
| + | ! scope="col" class="sortable" width="100pt"| Versie |
− | </gallery>
| + | ! scope="col" class="sortable" width="100pt"| Status |
− | | + | ! scope="col" class="unsortable" width="600pt"| Toelichting |
− | = Koppelingen =
| + | |- |
− | | + | |[[Koppelprofiel_Active_directory|Active directory]] |
− | === Active Directory ===
| + | |1.0 |
− | | + | |In gebruik |
− | | + | |Voor het importeren van gebruikers |
− | Usergegevens worden door de beheerserver opgehaald met een readonly account. Deze heeft enkel leesrechten nodig op de Active Directory. Hiermee worden alle gebruikers opgehaald uit de Users OU of applicatiegroep. Dit gebeurt om de vijf minuten. De data van de gebruikers worden d.m.v. de Windows Service ‘Password synchronization for Unix systems’ gesynchroniseerd met de OpenLDAP van het zaaksysteem. Zodra een gebruiker wordt aangemaakt, zijn wachtwoord wijzigt of wordt verwijderd wordt deze actie ook verstuurd naar de beheerserver. Wijzigingen m.b.t. wachtwoorden zullen live worden gepushed naar de beheerserver op port 6677. De wachtwoorden worden direct gehashed opgeslagen voor verwerking.
| + | |- |
− | | + | |[[Koppelprofiel_Afspraken|Afspraken]] |
− | Deze worden ‘gemerged’ met de wachtwoorden, en worden direct in een beveiligde XML verstuurd naar de omgeving in de overheidscloud. De beheerserver maakt gebruik van een HTTPS verbinding die alleen met behulp van een API-Key kan worden opgezet.
| + | |1.0 |
− | | + | |In gebruik |
− | === BAG-import ===
| + | |Voor koppelingen met Lamson, Qmatic, SuperSaaS |
− | === BuitenBeter ===
| + | |- |
− | === DigiD ===
| + | |[[Koppelprofiel_BAG_import|BAG-import]] |
− | === eHerkenning ===
| + | |1.0 |
− | === Key2Burgerzaken ===
| + | |In gebruik |
− | === Key2Financien ===
| + | |Voor het importeren van de BAG-objecten, met name de adressen |
− | Dit is een export feature die zaken met financiele informatie exporteert, en na een complete export de zaken sluit.<br>
| + | |- |
− | <br>
| + | |[[Koppelprofiel_BuitenBeter|BuitenBeter]] |
− | =====Configuratie=====
| + | |1.6 |
− | Maak eerst een exportprofiel aan:<br>
| + | |In gebruik |
− | <ul> | + | |Meldingen die worden gedaan via de [http://www.buitenbeter.nl BuitenBeter] App worden als zaken aangemaakt |
− | <li>Ga naar het configuratiescherm en klik op de plusknop</li>
| + | |- |
− | <li>Selecteer het type 'Key2Finance'</li>
| + | |[[Koppelprofiel_GWS4ALL|GWS4ALL]] |
− | <li>Geef een naam op, bijvoorbeeld die van het product in kwestie</li>
| + | |1.0 |
− | </ul>
| + | |In gebruik |
− | <br>
| + | |Voor het uitwisselen van gegevens tussen het zaaksysteem en de GWS4ALL applicatie |
− | [[bestand:Koppeling nieuw.png]]<br> | + | |- |
− | <br>
| + | |[[Koppelprofiel_Key2Burgerzaken|Key2Burgerzaken]] |
− | Stel nu de volgende instellingen in:
| + | |2.1 |
− | <ul>
| + | |In gebruik |
− | <li>Geef een API key op, met de key kan een externe partij authenticeren.<br>Een goede method om een key te genereren is een GUID tool zoals
| + | |Voor het uitwisselen van gegevens tussen het zaaksysteem en de Key2Burgerzaken applicatie |
− | http://www.guidgenerator.com</li>
| + | |- |
− | <li>Kies een zaaktype waarop gefilterd moet worden. De exportmodule zal alle zaken selecteren van dat zaaktype die klaar staan om afgerond te worden. Dat wil o.a. zeggen dat een resultaat ingevuld is, alle verplichte velden aanstaan en de zaak in de laatste fase is.</li>
| + | |[[Koppelprofiel_Key2Financien|Key2Financien]] |
− | <li>Stel vervolgens de gegevensmapping in. Een uitgebreide beschrijving hiervan volgt hieronder.</li>
| + | | |
− | <li>Activeer de koppeling</li>
| + | |Niet meer in gebruik |
− | </ul>
| + | |Voor het uitwisselen van gegevens tussen het zaaksysteem en de Key2Financien applicatie |
− | <br>
| + | |- |
− | [[bestand:Koppelingen key2finance.png]]<br> | + | |[[Koppelprofiel_Overheid_IO_koppelingen|Overheid IO koppelingen]] |
− | <br>
| + | |1.0 |
− | In de gegevensmapping worden twee kolommen getoond. De linkerkolom toont de namen van de 'kolommen' van het CSV bestand. De rechterkolom moet ingevuld worden met de (systeem)kenmerken. Bij de export wordt de data uit die kenmerken geplaatst in de kolommen van het CSV bestand.<br> | + | |In gebruik |
− | <br>
| + | |Voor het importeren van organisatiecontacten via OpenKvK |
− | [[bestand:Koppelingen gegevensmapping key2finance.png]]<br> | + | |- |
− | <br>
| + | |[[Koppelprofiel_MijnOverheid|MijnOverheid]] |
− | | + | |3.10 v1.1 |
− | =====Uitvoer=====
| + | |In gebruik |
− | Het uitvoeren van de export bestaat uit 4 stappen. Elke stap is het invoeren van een URL in de navigatiebalk van de browser. In de URL's moeten verschillende variabele handmatig worden ingevoerd. Vervang hiervoor simpewel '<u><dit></u>' gedeelte door de variabele, bijvoorbeeld: '<u>52</u>'<br>
| + | |Voor het versturen van StUF-Zaakberichten naar MijnOverheid |
− | {| class="wikitable"
| + | |- |
| + | |[[Koppelprofiel_Ogone|Ogone]] |
| + | | |
| + | |In gebruik |
| + | |Voor de online betaling bij het online aanvragen van zaken |
| + | |- |
| + | |[[Koppelprofiel Publieke zoekopdracht|Publieke zoekopdracht]] |
| + | |<nowiki>-</nowiki> |
| + | |In gebruik |
| + | |Voor het openbaar toegankelijk maken van het zakenoverzicht van een zoekopdracht |
| + | |- |
| + | |[[Koppelprofiel_stuf-nps|StUF-NPS]] |
| + | |3.10 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_StuF_PRS|StUF-PRS]] |
| + | |2.04 |
| + | |Niet meer in gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_StuF_ADR|StUF adressen]] |
| + | |2.04 en 3.10 v1.1 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_StuF_NNP|StUF-NNP]] |
| + | |2.04 v1.1 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_StuF_DCR|StUF-DCR]] |
| + | |1.0 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_Telefooncentrale|Telefooncentrale]] |
| + | |1.0 |
| + | |In gebruik |
| + | |Voor het uitwisselen van gegevens tussen het zaaksysteem en de telefooncentrale |
| + | |- |
| + | |[[Koppelprofiel_Scanstraat|Scanstraat]] |
| + | |1.2 |
| + | |In gebruik |
| + | |Voor het ontvangen van ingescande documenten |
| + | |- |
| + | |[[Koppelprofiel_Zaakinformatie_bevragen|Zaakinformatie bevragen]] |
| + | |1.0 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_I-navigator|I-Navigator]] |
| + | |1.5 |
| + | |In gebruik |
| + | |Importmodule voor het importeren van zaaktypen uit de I-Navigator |
| + | |- |
| + | |[[Producten en vragen importeren|PDC - Kluwer / SDU]] |
| + | |1.1 / 4.0 |
| + | |In gebruik |
| + | |Importmodule voor het importeren van producten en vragen van Kluwer / SDU |
| + | |- |
| + | |[[Koppelprofiel SDU Connect|SDU Connect]] |
| + | |1.0 |
| + | |In gebruik |
| + | |Importmodules voor het importeren en synchroniseren van SDU producten en vragen |
| + | |- |
| + | |[[Koppelprofiel_Omgevingsloket|Omgevingsloket (OLO)]] |
| + | | StuF 3.12 |
| + | |In gebruik |
| + | |Koppelprofiel voor het automatisch verwerken van berichtenverkeer uit de OLO |
| + | |- |
| + | |[[Koppelprofiel SAML IDP|SAML 2.0 Identity Provider]] |
| + | |SAML 2.0 |
| + | |In gebruik |
| + | |Koppelprofiel voor het inloggen op zaaksysteem via DigiD, eHerkenning, eIDAS en de AD |
| + | |- |
| + | |[[Koppelprofiel SAML SP|SAML 2.0 Service Provider]] |
| + | |SAML 2.0 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_Email#Uitgaande_mailconfiguratie|Uitgaande mailconfiguratie]] |
| + | |1.0 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_Email#Pop3Mailbox|Pop3Mailbox]] |
| + | |1.0 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_Email#Inkomende_mailafhandeling|Inkomende mailafhandeling]] |
| + | |1.0 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel_Email#Ingeplande_e-mail|Ingeplande email]] |
| + | |1.0 |
| + | |In gebruik |
| + | |Voor het inplannen van e-mails |
| + | |- |
| + | |[[Koppelprofiel Kaartconfiguratie|Kaartconfiguratie]] |
| + | |1.0 |
| + | |In gebruik |
| + | |Voor het gebruik van WMS-kaartlaag services |
| + | |- |
| + | |[[Koppelprofiel Zaaksysteem API|Zaaksysteem API]] |
| + | |1.0 |
| + | |In gebruik |
| + | | |
| + | |- |
| + | |[[Koppelprofiel Alternatieve authenticatie|Alternatieve authenticatie]] |
| + | |<nowiki>-</nowiki> |
| + | |In gebruik |
| + | |Voor twofactorauthenticatie |
| |- | | |- |
− | ! scope="col"| Variabele
| + | |[[Koppelprofiel Xential|Xential]] |
− | ! scope="col"| Locatie
| + | |<nowiki>-</nowiki> |
| + | |In gebruik |
| + | |Voor het gebruik van de externe documentgenerator van Xential |
| |- | | |- |
− | | <omgeving> | + | |[[Koppelprofiel StUF-ZKN|StUF-ZKN]] |
− | | De gemeentenaam uit de zaaksysteem-URL: <u>gemeentenaam</u>.zaaksysteem.nl | + | |3.10 v1.1 |
| + | |In gebruik |
| + | | |
| |- | | |- |
− | | <interface_id> | + | |[[Koppelprofiel StUF-ZKN Client|StUF-ZKN Consumer]] |
− | | Het cijfer dat achter de naam van de koppeling wordt weergegeven, in het configuratiescherm | + | |3.10 v1.1 |
| + | |In gebruik |
| + | | |
| |- | | |- |
− | | <api_key> | + | |[[Koppelprofiel DataB MultiChannel DMS|DataB MultiChannel DMS]] |
− | | De opgegeven tekst in het API-veld de koppeling, in het configuratiescherm | + | |<nowiki>-</nowiki> |
| + | |In gebruik |
| + | | |
| |- | | |- |
− | | <transactionID> | + | |[[Koppelprofiel iWMO en iJW|iWMO en iJW]] |
− | | Deze is terug te vinden onderaan de pagina die getoond wordt na het invoeren van de eerste URL | + | |2.0 |
− | |}
| + | |In gebruik |
− | <ol>
| + | |Voor het versturen en verwerken van beschikkingen op basis van iWMO2.0 en iJW2.0 |
− | <li><b>Transactie klaarzetten:</b><br>
| |
− | https://<u><omgeving></u>.zaaksysteem.nl/sysin/interface/<u><interface_id></u>/trigger/set_case_list?api_key=<u><api_key></u><br>
| |
− | <br>
| |
− | Helemaal onderaan staat het ‘transaction_id’, welke nodig is in de volgende stappen.<br>
| |
− | </li><br>
| |
− | <li><b>STDDEB.csv downloaden</b><br>
| |
− | https://<u><omgeving></u>.zaaksysteem.nl/sysin/interface/<u><interface_id></u>/trigger/get_csv_deb?zapi_format=csv&transaction_id=<u><transactionID></u>&api_key=<u><api_key></u><br>
| |
− | </li><br>
| |
− | <li><b>STDNAW.csv downloaden</b><br>
| |
− | https://<u><omgeving></u>.zaaksysteem.nl/sysin/interface/<u><interface_id></u>/trigger/get_csv_naw?zapi_format=csv&transaction_id=<u><transactionID></u>&api_key=<u><api_key></u><br>
| |
− | </li><br>
| |
− | <li><b>Transactie afsluiten</b><br>
| |
− | https://<u><omgeving></u>.zaaksysteem.nl/sysin/interface/<u><interface_id></u>/trigger/close_cases?transaction_id=<u><transactionID></u>&api_key=<u><api_key></u><br>
| |
− | <br>
| |
− | Dit maakt de transactie af, en sluit de geexporteerde zaken.<br>
| |
− | Let op: Fase acties worden niet uitgevoerd. De zaak wordt afgesloten dmv. de vroegtijdig afsluiten methode.
| |
− | </li>
| |
− | </ol>
| |
− | <br>
| |
− | | |
− | === KVK-import===
| |
− | === Ogone ===
| |
− | === StUF-PRS ===
| |
− | | |
− | ===== StUF-PRS attributes =====
| |
− | <pre>
| |
− | 'required' => [qw/
| |
− | straatnaam
| |
− | huisnummer
| |
− | postcode
| |
− | | |
− | burgerservicenummer
| |
− | geslachtsnaam
| |
− | geslachtsaanduiding
| |
− | geboortedatum
| |
− | /],
| |
− | 'optional' => [qw/
| |
− | voornamen
| |
− | huisnummertoevoeging
| |
− | huisletter
| |
− | woonplaats
| |
− | geboorteplaats
| |
− | geboorteland
| |
− | a_nummer
| |
− | [...]
| |
− | | |
− | </pre>
| |
− | | |
− | ===== StUF-PRS example message =====
| |
− | | |
− | <pre>
| |
− | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
| |
− | <soapenv:Body>
| |
− | <BG:kennisgevingsBericht xmlns:BG="http://www.egem.nl/StUF/sector/bg/0204" xmlns:StUF="http://www.egem.nl/StUF/StUF0204" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
| |
− | <StUF:stuurgegevens xmlns="http://www.egem.nl/StUF/StUF0204">
| |
− | <StUF:berichtsoort>Lk01</StUF:berichtsoort>
| |
− | <StUF:entiteittype>PRS</StUF:entiteittype>
| |
− | <StUF:sectormodel>BG</StUF:sectormodel>
| |
− | <StUF:versieStUF>0204</StUF:versieStUF>
| |
− | <StUF:versieSectormodel>0204</StUF:versieSectormodel>
| |
− | <StUF:zender>
| |
− | <StUF:applicatie>CMODIS</StUF:applicatie>
| |
− | </StUF:zender>
| |
− | <StUF:ontvanger>
| |
− | <StUF:applicatie>ZSNL</StUF:applicatie>
| |
− | </StUF:ontvanger>
| |
− | <StUF:referentienummer>MK0000229154</StUF:referentienummer>
| |
− | <StUF:tijdstipBericht>2012110209011458</StUF:tijdstipBericht>
| |
− | <StUF:kennisgeving>
| |
− | <StUF:mutatiesoort>T</StUF:mutatiesoort>
| |
− | <StUF:indicatorOvername>V</StUF:indicatorOvername>
| |
− | </StUF:kennisgeving>
| |
− | </StUF:stuurgegevens>
| |
− | <BG:body xmlns="http://www.egem.nl/StUF/sector/bg/0204">
| |
− | <BG:PRS StUF:sleutelGegevensbeheer="1243796" StUF:sleutelVerzendend="1243796" StUF:verwerkingssoort="T" soortEntiteit="F">
| |
− | <BG:a-nummer>1234567890</BG:a-nummer>
| |
− | <BG:bsn-nummer>987654321</BG:bsn-nummer>
| |
− | <BG:voornamen>Tinues</BG:voornamen>
| |
− | <BG:voorletters>V</BG:voorletters>
| |
− | <BG:geslachtsnaam>Testpersoon</BG:geslachtsnaam>
| |
− | <BG:geboortedatum>19620529</BG:geboortedatum>
| |
− | <BG:geslachtsaanduiding>M</BG:geslachtsaanduiding>
| |
− | <BG:tijdvakGeldigheid>
| |
− | <StUF:begindatumTijdvakGeldigheid>19620529</StUF:begindatumTijdvakGeldigheid>
| |
− | <StUF:einddatumTijdvakGeldigheid StUF:noValue="geenWaarde" xsi:nil="true"/>
| |
− | </BG:tijdvakGeldigheid>
| |
− | <BG:PRSADRVBL StUF:sleutelGegevensbeheer="1243798" StUF:sleutelVerzendend="1243798" StUF:verwerkingssoort="T" soortEntiteit="R">
| |
− | <BG:tijdvakRelatie>
| |
− | <StUF:begindatumRelatie>20121030</StUF:begindatumRelatie>
| |
− | <StUF:einddatumRelatie StUF:noValue="geenWaarde" xsi:nil="true"/>
| |
− | </BG:tijdvakRelatie>
| |
− | <BG:extraElementen>
| |
− | <StUF:extraElement naam="aanduidingGegevensInOnderzoek">N</StUF:extraElement>
| |
− | </BG:extraElementen>
| |
− | <BG:ADR StUF:sleutelGegevensbeheer="22628" StUF:sleutelVerzendend="22628" StUF:verwerkingssoort="T" soortEntiteit="F">
| |
− | <BG:postcode>1015JL</BG:postcode>
| |
− | <BG:woonplaatsnaam>Amsterdam</BG:woonplaatsnaam>
| |
− | <BG:straatnaam>Donker Curtiusstraat</BG:straatnaam>
| |
− | <BG:huisnummer>7</BG:huisnummer>
| |
− | <BG:ingangsdatum>19511115</BG:ingangsdatum>
| |
− | <BG:einddatum StUF:noValue="geenWaarde" xsi:nil="true"/>
| |
− | <BG:extraElementen>
| |
− | <StUF:extraElement naam="officieleStraatnaam">Donker Curtiusstraat</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatieNummerAanduiding">0716200000762034</StUF:extraElement>
| |
− | <StUF:extraElement naam="authentiekeWoonplaatsnaam">Amsterdam</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatiecodeVerblijfplaats">0716010000028347</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatieTGO">0716010000028347</StUF:extraElement>
| |
− | <StUF:extraElement naam="openbareRuimteNaam">Donker Curtiusstraatt</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatieAOA">0716200000762034</StUF:extraElement>
| |
− | <StUF:extraElement naam="woonplaatsNaamBAG">Amsterdam</StUF:extraElement>
| |
− | </BG:extraElementen>
| |
− | </BG:ADR>
| |
− | </BG:PRSADRVBL>
| |
− | </BG:PRS>
| |
− | </BG:body>
| |
− | </BG:kennisgevingsBericht>
| |
− | </soapenv:Body></soapenv:Envelope>
| |
− | </pre>
| |
− | ''LET OP: Bovenstaande gegevens zijn geen reflectie van de werkelijkheid''
| |
− | | |
− | === StUF-ADR ===
| |
− | | |
− | ===== StUF-ADR attributes =====
| |
− | | |
− | <pre>
| |
− | required => [qw/
| |
− | identificatie
| |
− | woonplaats
| |
− | openbareruimte
| |
− | postcode
| |
− | huisnummer
| |
− | status
| |
− | inonderzoek
| |
− | /],
| |
− | optional => [qw/
| |
− | huisletter
| |
− | huisnummertoevoeging
| |
− | | |
− | correctie
| |
− | documentnummer
| |
− | documentdatum
| |
− | type
| |
− | einddatum
| |
− | gebruiksobject_id
| |
− | woonplaats_naam
| |
− | straatnaam
| |
− | officieel
| |
− | begindatum
| |
− | /],
| |
− | </pre>
| |
− | | |
− | ===== StUF-ADR example message =====
| |
− | | |
− | <pre>
| |
− | <BG:kennisgevingsBericht xmlns:BG="http://www.egem.nl/StUF/sector/bg/0204" xmlns:StUF="http://www.egem.nl/StUF/StUF0204" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
| |
− | <StUF:stuurgegevens xmlns="http://www.egem.nl/StUF/StUF0204">
| |
− | <StUF:berichtsoort>Lk01</StUF:berichtsoort>
| |
− | <StUF:entiteittype>ADR</StUF:entiteittype>
| |
− | <StUF:sectormodel>BG</StUF:sectormodel>
| |
− | <StUF:versieStUF>0204</StUF:versieStUF>
| |
− | <StUF:versieSectormodel>0204</StUF:versieSectormodel>
| |
− | <StUF:zender>
| |
− | <StUF:applicatie>ZNDAPP</StUF:applicatie>
| |
− | </StUF:zender>
| |
− | <StUF:ontvanger>
| |
− | <StUF:applicatie>ONTVAPP</StUF:applicatie>
| |
− | </StUF:ontvanger>
| |
− | <StUF:referentienummer>ZS0000000001</StUF:referentienummer>
| |
− | <StUF:tijdstipBericht>2012112316002368</StUF:tijdstipBericht>
| |
− | <StUF:kennisgeving>
| |
− | <StUF:mutatiesoort>T</StUF:mutatiesoort>
| |
− | <StUF:indicatorOvername>V</StUF:indicatorOvername>
| |
− | </StUF:kennisgeving>
| |
− | </StUF:stuurgegevens>
| |
− | <BG:body xmlns="http://www.egem.nl/StUF/sector/bg/0204">
| |
− | <BG:ADR StUF:sleutelGegevensbeheer="27178" StUF:sleutelVerzendend="27178" StUF:verwerkingssoort="T" soortEntiteit="F">
| |
− | <BG:postcode>1015XK</BG:postcode>
| |
− | <BG:woonplaatsnaam>Amsterdam</BG:woonplaatsnaam>
| |
− | <BG:straatnaam>Donker Curtiusstraat</BG:straatnaam>
| |
− | <BG:huisnummer>7</BG:huisnummer>
| |
− | <BG:huisletter></BG:huisletter>
| |
− | <BG:huisnummertoevoeging>414</BG:huisnummertoevoeging>
| |
− | <BG:aanduidingBijHuisnummer StUF:noValue="geenWaarde" xsi:nil="true"/>
| |
− | <BG:locatieomschrijving StUF:noValue="nietGeautoriseerd" xsi:nil="true"/>
| |
− | <BG:locatieadresnummer StUF:noValue="nietGeautoriseerd" xsi:nil="true"/>
| |
− | <BG:ingangsdatum>20070403</BG:ingangsdatum>
| |
− | <BG:einddatum StUF:noValue="geenWaarde" xsi:nil="true"/>
| |
− | <BG:straatcode>9999</BG:straatcode>
| |
− | <BG:buurtcode>0</BG:buurtcode>
| |
− | <BG:wijkcode>0</BG:wijkcode>
| |
− | <BG:gemeentecode>363</BG:gemeentecode>
| |
− | <BG:tijdvakGeldigheid>
| |
− | <StUF:begindatumTijdvakGeldigheid>20100302</StUF:begindatumTijdvakGeldigheid>
| |
− | <StUF:einddatumTijdvakGeldigheid StUF:noValue="geenWaarde" xsi:nil="true"/>
| |
− | </BG:tijdvakGeldigheid>
| |
− | <BG:extraElementen>
| |
− | <StUF:extraElement naam="officieleStraatnaam">Donker Curtiusstraat</StUF:extraElement>
| |
− | <StUF:extraElement naam="aanduidingGegevensInOnderzoek">N</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatieNummerAanduiding">0363200000756684</StUF:extraElement>
| |
− | <StUF:extraElement naam="authentiekeIdentificatieOpenbareRuimte">0363300000000059</StUF:extraElement>
| |
− | <StUF:extraElement naam="authentiekeIdentificatieWoonplaats">1024</StUF:extraElement>
| |
− | <StUF:extraElement naam="authentiekeWoonplaatsnaam">Amsterdam</StUF:extraElement>
| |
− | <StUF:extraElement naam="statusCodeOmschrijving">Naamgeving uitgegeven</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatiecodeVerblijfplaats">0363010000032757</StUF:extraElement>
| |
− | <StUF:extraElement naam="status">Naamgeving uitgegeven</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatieTGO">0363010000032757</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatieWoonplaats">1024</StUF:extraElement>
| |
− | <StUF:extraElement naam="openbareRuimteNaam">Donker Curtiusstraat</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatieAOA">0363200000756684</StUF:extraElement>
| |
− | <StUF:extraElement naam="identificatieOpenbareRuimte">0363300000000059</StUF:extraElement>
| |
− | <StUF:extraElement naam="woonplaatsNaamBAG">Amsterdam</StUF:extraElement>
| |
− | </BG:extraElementen>
| |
− | </BG:ADR>
| |
− | </BG:body>
| |
− | </BG:kennisgevingsBericht>
| |
− | </pre>
| |
− | ''LET OP: Bovenstaande gegevens zijn geen reflectie van de werkelijkheid''
| |
− | | |
− | === StUF-VBO ===
| |
− | === StUF-NNP ===
| |
− | === Telefooncentrale ===
| |
− | === WOZ-import ===
| |
− | === Zaakinformatie bevragen ===
| |
− | ===== Korte uitleg (Zaken obv JSON) =====
| |
− | Zaaksysteem biedt een mogelijk om zaakinformatie op te vragen van zaken die door middel van een publieke zoekopdracht te benaderen. De resultaten (zaakinformtie) van deze zoekopdracht worden terug gegeven in JSON-formaat en kunnen daarna gepresenteerd worden bijvoorbeeld door een CMS.<br>
| |
− | <br>
| |
− | ===== Welke data kan opgevraagd worden? =====
| |
− | De resultaten van zaken in een (publiek gepubliceerde) zoekopdracht. Hierbij is een set van gegevens op te vragen, namelijk:<br>
| |
− | | |
− | * Zaaknummer (zaak.id)
| |
− | * Zaaktype (zaaktype.naam)
| |
− | * Registratiedatum
| |
− | * Afhandeldatum
| |
− | * Status (zaak.status)
| |
− | * Fase (naam)
| |
− | * Extra informatie (zaak.onderwerp)
| |
− | * Resultaat (zaak.resultaat)
| |
− | <br>
| |
− | ===== Hoe wordt de data ontvangen? =====
| |
− | De data wordt gerouterneerd in JSON formaat. De zaken zelf staan in de property 'result', wat altijd een array is. In het geval van een foutmelding is het eerste object in de 'result' array een foutmeldingobject. In principe wordt de HTTP status code in dit geval ook op 500 gezet. Deze status code zit ook in het antwoord in de property 'status_code'. In de properties 'next' en 'prev' staan de URLs waarmee volgende en vorige pagina's kunnen worden opgevraagd, 'at' is de huidige pagina, 'num_rows' het totaal aantal zaken wat aan de zoekopdrachten voldoet, en 'rows' is het aantal zaken wat in dit antwoord wordt teruggegeven.<br>
| |
− | <br>
| |
− | ===== Hoe kan data worden bevraagd? =====
| |
− | De url van de call is {host}/public/search_case/?search_query_id={id}, waarbij {host} bijvoorbeeld 'https://mintlab.zaalsysteem.nl' is, en {id} het id van de gepubliceerde zoekopdracht.<br>
| |
− | <br>
| |
− | ===== Hoe moet data worden verwerkt? =====
| |
− | De data komt terug in een JSON string, die geparsed moet worden. De hashes met de kenmerken van de gevonden zaken staan in de property 'result' in een array.<br>
| |
− | <br>
| |
− | ===== Voorbeeldvraag =====
| |
− | https://quarterly.zaaksysteem.nl/public/search_case/?search_query_id=1<br>
| |
− | <br>
| |
− | ===== Voorbeeldantwoord =====
| |
− | <pre>
| |
− | {
| |
− | "next": null,
| |
− | "comment": "This is not a DBIx::Class::ResultSet and does NOT support paging.",
| |
− | "prev": null,
| |
− | "at": null,
| |
− | "num_rows": 1,
| |
− | "rows": null,
| |
− | "result": [
| |
− | [
| |
− | {
| |
− | "afhandeldatum": null,
| |
− | "zaaktype": "bagtest",
| |
− | "status": "new",
| |
− | "fase": "Naam van Fase komt hier",
| |
− | "onderwerp": null,
| |
− | "registratiedatum": "2013-09-05T12:33:57",
| |
− | "resultaat": null,
| |
− | "id": 155
| |
− | }
| |
− | ]
| |
− | ]
| |
− | }
| |
− | </pre>
| |
− | | |
− | === Zoekopdracht als kaart publiceren ===
| |
− | Wanneer in de instellingen wordt opgegeven dat de zoekopdracht gepubliceerd moet kunnen worden, kan ook de kaart gepubliceerd worden.<br>
| |
− | <br>
| |
− | [[bestand:Zoekopdracht instellingen.png]]<br>
| |
− | <br>
| |
− | Gebruik hiervoor de volgende link:
| |
− | http://<omgeving>/search/<id>/results/public_map<br>
| |
− | {| class="wikitable"
| |
| |- | | |- |
− | ! scope="col"| Variabele
| + | |[[Koppelprofiel Next2Know|Next2Know]] |
− | ! scope="col"| Locatie
| + | |<nowiki>-</nowiki> |
− | |- | + | |In gebruik |
− | | <omgeving> | + | | |
− | | De gemeentenaam uit de zaaksysteem-URL: <u>gemeentenaam</u>.zaaksysteem.nl
| |
| |- | | |- |
− | | <id> | + | |[[Koppelprofiel OpenCage|OpenCage]] |
− | | Dit cijfer is terug te vinden in de URL wanneer de zoekopdracht intern bekeken wordt<br>[[bestand:Zoekopdracht URL.png]] | + | |<nowiki>-</nowiki> |
| + | |In gebruik |
| + | | |
| |} | | |} |
| + | |
| + | ''* Indien u gebruik wilt maken van een koppelprofiel adviseren wij u contact op te nemen met de leverancier voor actuele informatie en mogelijkheden.'' |