Wiki-Quellcode von Melderegisterauskunft
Zuletzt geändert von MACH ProForms GmbH am 04.07.2024
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 dennoch von Mach ProForms GmbH empfohlen. | ||
| 31 | |||
| 32 | "Werte für Queue-Messaging Konfiguration" sind standardmäßig nicht zu befüllen. Eine Einrichtung wird dennoch von Mach ProForms GmbH 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. Nachfolgend ein Beispiel der Version 2.4. Die Werte der Parameter sind je nach Kunden spezifisch anzupassen. | ||
| 37 | |||
| 38 | ``` | ||
| 39 | Aktionsname des WebServices | ||
| 40 | abfrage0600 | ||
| 41 | Parametername | ||
| 42 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}nachrichtenkopf*.{http://www.osci.de/xmeld24}anwenderkennung | ||
| 43 | Wert des Parameters | ||
| 44 | TESTUSER | ||
| 45 | |||
| 46 | Aktionsname des WebServices | ||
| 47 | abfrage0600 | ||
| 48 | Parametername | ||
| 49 | {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* | ||
| 50 | Wert des Parameters | ||
| 51 | 1 | ||
| 52 | |||
| 53 | Aktionsname des WebServices | ||
| 54 | abfrage0600 | ||
| 55 | Parametername | ||
| 56 | {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* | ||
| 57 | Wert des Parameters | ||
| 58 | 01 | ||
| 59 | |||
| 60 | Aktionsname des WebServices | ||
| 61 | abfrage0600 | ||
| 62 | Parametername | ||
| 63 | {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* | ||
| 64 | Wert des Parameters | ||
| 65 | support@hsh-berlin.com | ||
| 66 | |||
| 67 | Aktionsname des WebServices | ||
| 68 | abfrage0600 | ||
| 69 | Parametername | ||
| 70 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}anwenderkennung | ||
| 71 | Wert des Parameters | ||
| 72 | TESTUSER | ||
| 73 | |||
| 74 | Aktionsname des WebServices | ||
| 75 | abfrage0600 | ||
| 76 | Parametername | ||
| 77 | {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* | ||
| 78 | Wert des Parameters | ||
| 79 | 2 | ||
| 80 | |||
| 81 | Aktionsname des WebServices | ||
| 82 | abfrage0600 | ||
| 83 | Parametername | ||
| 84 | {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* | ||
| 85 | Wert des Parameters | ||
| 86 | TEST§ | ||
| 87 | |||
| 88 | Aktionsname des WebServices | ||
| 89 | abfrage0600 | ||
| 90 | Parametername | ||
| 91 | {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* | ||
| 92 | Wert des Parameters | ||
| 93 | false | ||
| 94 | |||
| 95 | Aktionsname des WebServices | ||
| 96 | abfrage0600 | ||
| 97 | Parametername | ||
| 98 | {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* | ||
| 99 | Wert des Parameters | ||
| 100 | true | ||
| 101 | |||
| 102 | Aktionsname des WebServices | ||
| 103 | abfrage0600 | ||
| 104 | Parametername | ||
| 105 | {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* | ||
| 106 | Wert des Parameters | ||
| 107 | 2019-01-01T08:20:54 | ||
| 108 | |||
| 109 | Aktionsname des WebServices | ||
| 110 | abfrage0600 | ||
| 111 | Parametername | ||
| 112 | {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* | ||
| 113 | Wert des Parameters | ||
| 114 | 01 | ||
| 115 | |||
| 116 | Aktionsname des WebServices | ||
| 117 | abfrage0600 | ||
| 118 | Parametername | ||
| 119 | {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* | ||
| 120 | Wert des Parameters | ||
| 121 | 1 | ||
| 122 | |||
| 123 | Aktionsname des WebServices | ||
| 124 | abfrage0600 | ||
| 125 | Parametername | ||
| 126 | {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* | ||
| 127 | Wert des Parameters | ||
| 128 | 2019-01-01T08:20:54 | ||
| 129 | |||
| 130 | Aktionsname des WebServices | ||
| 131 | abfrage0600 | ||
| 132 | Parametername | ||
| 133 | {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 | ||
| 134 | Wert des Parameters | ||
| 135 | Adressermittlung | ||
| 136 | |||
| 137 | Aktionsname des WebServices | ||
| 138 | abfrage0600 | ||
| 139 | Parametername | ||
| 140 | {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 | ||
| 141 | Wert des Parameters | ||
| 142 | true | ||
| 143 | |||
| 144 | Aktionsname des WebServices | ||
| 145 | abfrage0600 | ||
| 146 | Parametername | ||
| 147 | {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* | ||
| 148 | Wert des Parameters | ||
| 149 | TESTANFRAGE | ||
| 150 | |||
| 151 | Aktionsname des WebServices | ||
| 152 | abfrage0600 | ||
| 153 | Parametername | ||
| 154 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600:produkthersteller* | ||
| 155 | Wert des Parameters | ||
| 156 | HSH | ||
| 157 | |||
| 158 | Aktionsname des WebServices | ||
| 159 | abfrage0600 | ||
| 160 | Parametername | ||
| 161 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600:produkt* | ||
| 162 | Wert des Parameters | ||
| 163 | OLMERA | ||
| 164 | |||
| 165 | Aktionsname des WebServices | ||
| 166 | abfrage0600 | ||
| 167 | Parametername | ||
| 168 | {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 | ||
| 169 | Wert des Parameters | ||
| 170 | 1 | ||
| 171 | |||
| 172 | Aktionsname des WebServices | ||
| 173 | abfrage0600 | ||
| 174 | Parametername | ||
| 175 | {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* | ||
| 176 | Wert des Parameters | ||
| 177 | 1 | ||
| 178 | |||
| 179 | Aktionsname des WebServices | ||
| 180 | abfrage0600 | ||
| 181 | Parametername | ||
| 182 | {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* | ||
| 183 | Wert des Parameters | ||
| 184 | 1 | ||
| 185 | |||
| 186 | Aktionsname des WebServices | ||
| 187 | abfrage0600 | ||
| 188 | Parametername | ||
| 189 | {XMeld24Auskunft}abfrage0600.{http://www.osci.de/xmeld24}melderegisterauskunfteinfach\.anforderung\.0600.{http://www.osci.de/xmeld24}zeichennachricht | ||
| 190 | Wert des Parameters | ||
| 191 | TEST2 | ||
| 192 | |||
| 193 | Aktionsname des WebServices | ||
| 194 | abfrage0600 | ||
| 195 | Parametername | ||
| 196 | {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 | ||
| 197 | Wert des Parameters | ||
| 198 | ADRESSERMITTLUNG | ||
| 199 | |||
| 200 | Aktionsname des WebServices | ||
| 201 | abfrage0600 | ||
| 202 | Parametername | ||
| 203 | {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* | ||
| 204 | Wert des Parameters | ||
| 205 | ags:00000000 | ||
| 206 | |||
| 207 | Aktionsname des WebServices | ||
| 208 | abfrage0600 | ||
| 209 | Parametername | ||
| 210 | {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* | ||
| 211 | Wert des Parameters | ||
| 212 | 00000000 | ||
| 213 | |||
| 214 | Aktionsname des WebServices | ||
| 215 | abfrage0600 | ||
| 216 | Parametername | ||
| 217 | {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* | ||
| 218 | Wert des Parameters | ||
| 219 | 0600 | ||
| 220 | |||
| 221 | Aktionsname des WebServices | ||
| 222 | abfrage0600 | ||
| 223 | Parametername | ||
| 224 | {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* | ||
| 225 | Wert des Parameters | ||
| 226 | 1 | ||
| 227 | ``` | ||
| 228 | |||
| 229 | ![[Webservice Header Parameter|@WebServiceHeaderParameter.jpg]] | ||
| 230 | |||
| 231 | 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. Die Werte "00000000" sind mit dem amtlichen Gemeindeschlüssel auszutauschen. | ||
| 232 | |||
| 233 | Unter "WebService-HeaderParameter" sind die obigen erwähnten Parameter "X-username" und "X-password" zu hinterlegen. | ||
| 234 | |||
| 235 | --- | ||
| 236 | |||
| 237 | ## Einbindung des Briefbogens | ||
| 238 | |||
| 239 | ### Aufbereitung | ||
| 240 | |||
| 241 | Der Briefbogen wird in ein mappbares PDF umgewandelt und mit assistentenspezifischen Feldern versehen, welches auf die MACH formsolutions Plattform hochgeladen wird. Auf Grund der spezifischen Felder wird eine Beauftragung von MACH ProForms GmbH zur Umwandlung und Einbindung empfohlen. | ||
| 242 | |||
| 243 | ### Einbindung als Auskunft | ||
| 244 | |||
| 245 | 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. | ||
| 246 | |||
| 247 | ![[Veröffentlichung|@Veroeffentlichung.jpg]] | ||
| 248 | |||
| 249 | ![[Konfiguration Assistentenantwortgenerierung|@Assistentenantwortgenerierung.jpg]] Über den Fieldmapping-Button auf der rechten Seite, muss das entsprechende Mapping erfolgen. | ||
| 250 | |||
| 251 | ![[Mapping PDF|@MappingPDF.jpg]] |