Wiki-Quellcode von Melderegisterauskunft
Version 1.1 von MACH ProForms GmbH am 10.03.2020
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | # Allgemeines | ||
| 2 | |||
| 3 | ## Voraussetzungen | ||
| 4 | |||
| 5 | - Ein Payment ist bereits eingerichtet am Mandanten. | ||
| 6 | - PDF und Assistentenrecht sind beim Mandanten vorhanden. | ||
| 7 | |||
| 8 | ## Relevante Daten | ||
| 9 | |||
| 10 | - WebService-Url | ||
| 11 | - Amtlicher Gemeindeschlüssel (AGS) | ||
| 12 | - X-username (base64-codierter Benutzername für das HSH Soft- und Hardware Vertriebs GmbH-System) | ||
| 13 | - X-password (base64-codiertes Passwort für das HSH Soft- und Hardware Vertriebs GmbH-System) | ||
| 14 | - Briefbogen des Kunden | ||
| 15 | |||
| 16 | ___ | ||
| 17 | |||
| 18 | # Konfiguration des WebServices | ||
| 19 | |||
| 20 | Es muss sichergestellt werden, dass der WebService "HSH-Melderegisterauskunft" bereits zur Verfügung steht (siehe hierzu "[[Webservice Einrichten|Main.07_Einstellungen-Fachadministration.03_Module.06_Webservice.01_WebserviceEinrichten]])". Hierzu kann entweder der Reiter Web Services - WebService-Definition oder WebService-Konfiguration genutzt werden. Ist die Replikation eingerichtet, sollte der WebService bereits vorhanden sein. | ||
| 21 | |||
| 22 | ![[Webservice-Definition|@WebServiceDefinition.jpg]] | ||
| 23 | |||
| 24 | Unter "WebService-Konfiguration" müssen anschließend die obigen erwähnten Daten erfasst werden. Hierzu wird der WebService-Name "HSH-Melderegisterauskunft", die WebService-OrganisationsID "22222222-2222", sowie die von dem Anbieter bereitgestellte, bestenfalls aktuellste WebService-Version ausgewählt. Anschließend wird die WebService-URL eingetragen, beispielsweise "https://www.meldebehoerde.de:443/cebit/IRWS/ws/XMeld24Service". | ||
| 25 | |||
| 26 | ![[Webservice Definition|@WebServiceDefinitionUrl.jpg]] | ||
| 27 | |||
| 28 | "Werte für HTTP-Basic Authentifikation" sind standardmäßig nicht zu befüllen. | ||
| 29 | |||
| 30 | "Werte für Zertifikatsauthentifizierung" sind standardmäßig nicht zu befüllen. Eine Einrichtung wird von Form-Solutions jedoch empfohlen. | ||
| 31 | |||
| 32 | "Werte für Queue-Messaging Konfiguration" sind standardmäßig nicht zu befüllen. Eine Einreichtung wird von Form-Solutions jedoch empfohlen (siehe hierzu "[[Security Paket|Main.07_Einstellungen-Fachadministration.03_Module.09_Security-Paket]])". | ||
| 33 | |||
| 34 | ![[Webservice Konfigurationsmaske|@WebServiceKonfiguration.jpg]] | ||
| 35 | |||
| 36 | Die Aktionsparameter sind zu definieren (siehe hierzu "[[Webservice Einrichten|Main.07_Einstellungen-Fachadministration.03_Module.06_Webservice.01_WebserviceEinrichten]]"). Diese sind je XMeld Version abweichend. | ||
| 37 | Nachfolgend ein Beispiel der Version 2.4. Die Werte der Parameter sind je nach Kunden spezifisch anzupassen. | ||
| 38 | |||
| 39 | ``` | ||
| 40 | Aktionsname des WebServices | ||
| 41 | abfrage0600 | ||
| 42 | Parametername | ||
| 43 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}anwenderkennung | ||
| 44 | Wert des Parameters | ||
| 45 | TESTUSER | ||
| 46 | |||
| 47 | Aktionsname des WebServices | ||
| 48 | abfrage0600 | ||
| 49 | Parametername | ||
| 50 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}empfaenger*.{http://www.osci.de/xmeld24}ORGANISATIONSEINHEIT[0].{http://www.osci.de/xmeld24}hierarchieebene* | ||
| 51 | Wert des Parameters | ||
| 52 | 1 | ||
| 53 | |||
| 54 | Aktionsname des WebServices | ||
| 55 | abfrage0600 | ||
| 56 | Parametername | ||
| 57 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}empfaenger*.{http://www.osci.de/xmeld24}erreichbarkeit[0].kanal*.code* | ||
| 58 | Wert des Parameters | ||
| 59 | 01 | ||
| 60 | |||
| 61 | Aktionsname des WebServices | ||
| 62 | abfrage0600 | ||
| 63 | Parametername | ||
| 64 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}empfaenger*.{http://www.osci.de/xmeld24}erreichbarkeit[0].kennung* | ||
| 65 | Wert des Parameters | ||
| 66 | support@hsh-berlin.com | ||
| 67 | |||
| 68 | Aktionsname des WebServices | ||
| 69 | abfrage0600 | ||
| 70 | Parametername | ||
| 71 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}anwenderkennung | ||
| 72 | Wert des Parameters | ||
| 73 | TESTUSER | ||
| 74 | |||
| 75 | Aktionsname des WebServices | ||
| 76 | abfrage0600 | ||
| 77 | Parametername | ||
| 78 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}anfragedaten*.{http://www.osci.de/xmeld24}gewerblicherZweck.{http://www.osci.de/xmeld24}angabeDesZwecks*.{http://www.osci.de/xmeld24}code[0].code* | ||
| 79 | Wert des Parameters | ||
| 80 | 2 | ||
| 81 | |||
| 82 | Aktionsname des WebServices | ||
| 83 | abfrage0600 | ||
| 84 | Parametername | ||
| 85 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}anfragedaten*.{http://www.osci.de/xmeld24}gewerblicherZweck.{http://www.osci.de/xmeld24}geschaeftszeichen* | ||
| 86 | Wert des Parameters | ||
| 87 | TEST§ | ||
| 88 | |||
| 89 | Aktionsname des WebServices | ||
| 90 | abfrage0600 | ||
| 91 | Parametername | ||
| 92 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}anfragedaten*.{http://www.osci.de/xmeld24}zumZweckdesAdresshandels* | ||
| 93 | Wert des Parameters | ||
| 94 | false | ||
| 95 | |||
| 96 | Aktionsname des WebServices | ||
| 97 | abfrage0600 | ||
| 98 | Parametername | ||
| 99 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}anfragedaten*.{http://www.osci.de/xmeld24}zumZweckDerWerbung* | ||
| 100 | Wert des Parameters | ||
| 101 | true | ||
| 102 | |||
| 103 | Aktionsname des WebServices | ||
| 104 | abfrage0600 | ||
| 105 | Parametername | ||
| 106 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}technische\.einzelidentifikation*.{http://www.osci.de/xmeld24}ereigniszeitpunkt* | ||
| 107 | Wert des Parameters | ||
| 108 | 2019-01-01T08:20:54 | ||
| 109 | |||
| 110 | Aktionsname des WebServices | ||
| 111 | abfrage0600 | ||
| 112 | Parametername | ||
| 113 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}steuerungsinformationen.{http://www.osci.de/xmeld24}option\.auskunft[0].code* | ||
| 114 | Wert des Parameters | ||
| 115 | 01 | ||
| 116 | |||
| 117 | Aktionsname des WebServices | ||
| 118 | abfrage0600 | ||
| 119 | Parametername | ||
| 120 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}anfragedaten*.{http://www.osci.de/xmeld24}einwilligungWurdeErteilt[0].code* | ||
| 121 | Wert des Parameters | ||
| 122 | 1 | ||
| 123 | |||
| 124 | Aktionsname des WebServices | ||
| 125 | abfrage0600 | ||
| 126 | Parametername | ||
| 127 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}identifikation\.nachricht*.{http://www.osci.de/xmeld24}erstellungszeitpunkt* | ||
| 128 | Wert des Parameters | ||
| 129 | 2019-01-01T08:20:54 | ||
| 130 | |||
| 131 | Aktionsname des WebServices | ||
| 132 | abfrage0600 | ||
| 133 | Parametername | ||
| 134 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}anfragedaten*.{http://www.osci.de/xmeld24}zeicheneinzelfall | ||
| 135 | Wert des Parameters | ||
| 136 | Adressermittlung | ||
| 137 | |||
| 138 | Aktionsname des WebServices | ||
| 139 | abfrage0600 | ||
| 140 | Parametername | ||
| 141 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}datenZurAnfrage*.{http://www.osci.de/xmeld24}name*.{http://www.osci.de/xmeld24}phonetik | ||
| 142 | Wert des Parameters | ||
| 143 | true | ||
| 144 | |||
| 145 | Aktionsname des WebServices | ||
| 146 | abfrage0600 | ||
| 147 | Parametername | ||
| 148 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}technische\.einzelidentifikation*.{http://www.osci.de/xmeld24}zeicheneinzelfall* | ||
| 149 | Wert des Parameters | ||
| 150 | TESTANFRAGE | ||
| 151 | |||
| 152 | Aktionsname des WebServices | ||
| 153 | abfrage0600 | ||
| 154 | Parametername | ||
| 155 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600:produkthersteller* | ||
| 156 | Wert des Parameters | ||
| 157 | HSH | ||
| 158 | |||
| 159 | Aktionsname des WebServices | ||
| 160 | abfrage0600 | ||
| 161 | Parametername | ||
| 162 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600:produkt* | ||
| 163 | Wert des Parameters | ||
| 164 | OLMERA | ||
| 165 | |||
| 166 | Aktionsname des WebServices | ||
| 167 | abfrage0600 | ||
| 168 | Parametername | ||
| 169 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}anfragedaten*.{http://www.osci.de/xmeld24}einwilligungWurdeErteilt[0]:listVersionID | ||
| 170 | Wert des Parameters | ||
| 171 | 1 | ||
| 172 | |||
| 173 | Aktionsname des WebServices | ||
| 174 | abfrage0600 | ||
| 175 | Parametername | ||
| 176 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}anfragedaten*.{http://www.osci.de/xmeld24}gewerblicherZweck.{http://www.osci.de/xmeld24}angabeDesZwecks*.{http://www.osci.de/xmeld24}code[0]:listVersionID* | ||
| 177 | Wert des Parameters | ||
| 178 | 1 | ||
| 179 | |||
| 180 | Aktionsname des WebServices | ||
| 181 | abfrage0600 | ||
| 182 | Parametername | ||
| 183 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}empfaenger*.{http://www.osci.de/xmeld24}ANSCHRIFT.gemeindeschluessel:listVersionID* | ||
| 184 | Wert des Parameters | ||
| 185 | 1 | ||
| 186 | |||
| 187 | Aktionsname des WebServices | ||
| 188 | abfrage0600 | ||
| 189 | Parametername | ||
| 190 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}zeichennachricht | ||
| 191 | Wert des Parameters | ||
| 192 | TEST2 | ||
| 193 | |||
| 194 | Aktionsname des WebServices | ||
| 195 | abfrage0600 | ||
| 196 | Parametername | ||
| 197 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}auskunft\.anforderung[0]*.{http://www.osci.de/xmeld24}anfragedaten*.{http://www.osci.de/xmeld24}gewerblicherZweck.{http://www.osci.de/xmeld24}angabeDesZwecks*.{http://www.osci.de/xmeld24}freitext | ||
| 198 | Wert des Parameters | ||
| 199 | ADRESSERMITTLUNG | ||
| 200 | |||
| 201 | Aktionsname des WebServices | ||
| 202 | abfrage0600 | ||
| 203 | Parametername | ||
| 204 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}empfaenger*.{http://www.osci.de/xmeld24}behoerdenkennung* | ||
| 205 | Wert des Parameters | ||
| 206 | ags:00000000 | ||
| 207 | |||
| 208 | Aktionsname des WebServices | ||
| 209 | abfrage0600 | ||
| 210 | Parametername | ||
| 211 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}empfaenger*.{http://www.osci.de/xmeld24}ANSCHRIFT.gemeindeschluessel.code* | ||
| 212 | Wert des Parameters | ||
| 213 | 00000000 | ||
| 214 | |||
| 215 | Aktionsname des WebServices | ||
| 216 | abfrage0600 | ||
| 217 | Parametername | ||
| 218 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}identifikation\.nachricht*.{http://www.osci.de/xmeld24}nachrichtennummer*.code* | ||
| 219 | Wert des Parameters | ||
| 220 | 0600 | ||
| 221 | |||
| 222 | Aktionsname des WebServices | ||
| 223 | abfrage0600 | ||
| 224 | Parametername | ||
| 225 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\\.anforderung\\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}identifikation\\.nachricht*.{http://www.osci.de/xmeld24}tagesvorgangszaehler* | ||
| 226 | Wert des Parameters | ||
| 227 | 1 | ||
| 228 | ``` | ||
| 229 | |||
| 230 | ![[Webservice Header Parameter|@WebServiceHeaderParameter.jpg]] | ||
| 231 | |||
| 232 | Für die Version 2.3 sind alle Referenzen {XMeld24Auskunft} mit {XMeld23Auskunft}, sowie {http://www.osci.de/xmeld24} mit {http://www.osci.de/xmeld23} zu ersetzen. | ||
| 233 | Die Werte "00000000" sind mit dem amtlichen Gemeindeschlüssel auszutauschen. | ||
| 234 | |||
| 235 | Unter "WebService-HeaderParameter" sind die obigen erwähnten Parameter "X-username" und "X-password" zu hinterlegen. | ||
| 236 | |||
| 237 | ___ | ||
| 238 | |||
| 239 | # Einbindung des Briefbogens | ||
| 240 | |||
| 241 | ## Aufbereitung | ||
| 242 | |||
| 243 | Der Briefbogen wird in ein mappbares PDF umgewandelt und mit assistentenspezifischen Feldern versehen, welches am Formularserver hochgeladen wird. | ||
| 244 | Auf Grund der spezifischen Felder wird eine Beauftragung von Form-Solutions zur Umwandlung und Einbindung empfohlen. | ||
| 245 | |||
| 246 | ## Einbindung als Auskunft | ||
| 247 | |||
| 248 | Damit die Melderegisterauskunft nach dem Bezahlvorgang ausgegeben wird, muss in der Veröffentlichungsmaske die "[[automatische Assistentenantwortgenerierung|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]]" das zuvor hochgeladene PDF ausgewählt werden. | ||
| 249 | |||
| 250 | ![[Veröffentlichung|@Veroeffentlichung.jpg]] | ||
| 251 | |||
| 252 | ![[Konfiguration Assistentenantwortgenerierung|@Assistentenantwortgenerierung.jpg]] | ||
| 253 | Über den Fieldmapping-Button auf der rechten Seite, muss das entsprechende Mapping erfolgen. | ||
| 254 | |||
| 255 | ![[Mapping PDF|@MappingPDF.jpg]] |