Koppelprofiel Key2Burgerzaken
Inhoud
Algemeen
Het koppelprofiel key2burgerzaken stelt in staat om verhuizingen die in zaaksysteem geregistreerd worden direct in de key2burgerzaken applicatie te registreren, en wanneer deze afgehandeld worden in de applicatie de geregistreerde zaken in zaaksysteem te laten afhandelen.
Koppelprofiel
Instellingen voor deze koppeling.
Configuratie
| Instelling | Omschrijving |
|---|---|
| URL Key2Burgerzaken | Bijvoorbeeld: http://key2burgerzaken.centric.nl/BOKoppelvlakPIV/PROD/Versie2_0/Service.asmx |
| Verhuizingsoort | Binnengemeentelijk, Buitengemeentelijk |
| Actie op verwerkte aanvraag | Geen actie, Zaak afhandelen
Let op: De inrichting van het geselecteerde zaaktype moet zo zijn dat aan alle voorwaarden van de Faseovergang voldaan is. |
| Zaakresultaat op verwerkte aanvraag | Let op: Moet overeenkomen met een resultaatmogelijkheid van het geselecteerde zaaktype |
| Gebruik BAG voor adres verhuizing | Met deze optie aan kan voor het adres gebruik gemaakt worden van één BAG-kenmerk (aanbevolen). Met deze optie uit moet voor het adres gebruik gemaakt worden van losse tekstkenmerken. |
Zaaktype interface
Het zaaktype waar verhuizingen op geregistreerd worden.
Let op: Voor het versturen van het bericht 'Verhuizing geregistreerd' aan de key2burgerzaken applicatie moet in het zaaktype ook een Extern systeembericht ingericht zijn.
Kenmerken koppelen
De volgende kenmerken moeten gekoppeld worden:
| Titel | Registratiefase | Fase 2+ | Type | Toelichting |
|---|---|---|---|---|
| Verhuisdatum | X | Datumkenmerk | - | |
| IndicatieInwonend | X | - | - | |
| Meeverhuizers.BurgerservicenummersMeeverhuizers | X | Opplusbaar tekstveld | Verplicht 8 of 9 cijfers
| |
| Meeverhuizers.OmschrijvingAangifte | X | Tekstveld | *Zie onderstaande toelichting | |
| Statuscode | X | Tekstveld | - | |
| Statusomschrijving | X | Groot tekstveld | - | |
| IndicatieMeldenAanBurger | X | Groot tekstveld | - | |
| BackOfficeID | X | Tekstveld | - | |
| Contactgegevens.Emailadres | X | Tekstveld of systeemkenmerk | Verplicht | |
| Contactgegevens.TelefoonnummerPrive | X | Tekstveld of systeemkenmerk | Eén van beide verplicht | |
| Contactgegevens.TelefoonnummerMobiel | X | Tekstveld of systeemkenmerk |
| Gebruik BAG voor adres verhuizing = aan (aanbevolen) | ||||
|---|---|---|---|---|
| Bagadres | X | Bag-kenmerk (adres) | Verplicht |
| Gebruik BAG voor adres verhuizing = uit | ||||
|---|---|---|---|---|
| Adresgegevens.Postcode | X | Tekstveld of systeemkenmerk | Verplicht | |
| Adresgegevens.Huisnummer | X | Tekstveld of systeemkenmerk | Verplicht | |
| Adresgegevens.Huisletter | X | Tekstveld of systeemkenmerk | - | |
| Adresgegevens.Huisaanduiding | X | Tekstveld of systeemkenmerk | - | |
| Adresgegevens.Huistoevoeging | X | Tekstveld of systeemkenmerk | - |
| Titel | Registratiefase | Fase 2+ | Type | Toelichting |
|---|---|---|---|---|
| Adresgegevens.FunctieAdres | X | Tekstveld | - |
Meeverhuizers in meerdere kenmerken
De BSN's van meeverhuizers moeten kommagescheiden opgegeven worden voor Meeverhuizers.BurgerservicenummersMeeverhuizers. Dit kan op twee manieren:
- Alle informatie in één opplusbaar kenmerk
- De informatie in losse kenmerken
Plus één systeemkenmerk waarin de informatie met magicstring kommagescheiden worden opgebouwd
Plus één systeemkenmerk waarin de betekenis van de informatie wordt opgegeven
De laatste optie heeft de voorkeur. Het is hiermee mogelijk om zelf te beheren welke informatie in de export wordt opgenomen, en zelfs om dit dynamisch te maken middels regels.
Voorbeeld:
| Kenmerk | Kenmerktype | Voorbeeld invulling | Toelichting |
|---|---|---|---|
| BSN partner | Numeriek | 123456789 | |
| BSN kind 1 | Numeriek | 111111111 | |
| BSN kind 2 | Numeriek | 222222222 | |
| BSN kind 3 | Numeriek | 333333333 | |
| BSN kind 4 | Numeriek | 444444444 | |
| BSN kind 5 | Numeriek | 555555555 | |
| BSN gemachtigde | Numeriek | 121212121 | |
| BSN gezaghouder | Numeriek | 131313131 | |
| BSN inwonende ouder | Numeriek | 141414141 | |
| BSN inwonende ouder | Numeriek | 151515151 | |
| OmschrijvingAangifte | Tekstveld | P,K,K,K,K,K,G,O,O | Ingesteld als systeemkenmerk, ingevuld middels voorinvulling of regel.
|
| BurgerservicenummersMeeverhuizers | Tekstveld | [[bsn_partner]],[[bsn_kind_1]],[[bsn_kind_2]],[[bsn_kind_3]],[[bsn_kind_4]],[[bsn_kind_5]],[[bsn_gemachtigde]],[[bsn_ouder1]],[[bsn_ouder2]] | Ingesteld als systeemkenmerk, ingevuld middels voorinvulling of regel.
|
Transacties
Alle transacties zijn inzichtelijk via het transactieoverzicht.
Let op: Een transactie die verstuurd wordt na een periode van inactiviteit zal falen doordat Centric dit bericht niet goed zal ontvangen. De transactie wordt vervolgens voor 10min in de toekomst ingepland en zal dan wel goed ontvangen worden. Het is niet bekend hoe lang de periode van inactiviteit is wil dit zich voordoen.
