Lesende Backend-Schnittstellen
Identifizierung der MaLo
Identifizierung der MaLo
POST
https://mock.macoapp.de
/identifyMarketlocation
LESEN_MALOIDENT_BASIS
Übergibt die Daten zur Identifikation aller Marktlokationen gemäß Prozessbeschreibung, sowie aller Informationen zur Durchführung des EBD E_0594.
Identifizierung der MaLo › Request Body
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
| stammdaten* | Informationscontainer für Stammdaten, die zur Identifizierung genutzt werden | object |
| MARKTLOKATION[ ]* | — | object[] |
boTyp* | — | stringMARKTLOKATION |
versionStruktur* | — | string1 |
marktlokationsId | Identifiziert die Marktlokation mittels einer eindeutigen ID | Mapping auf identificationParameterId.maloId | string |
energierichtung* | Energieflussrichtung der Marktlokation | Mapping auf energyDirection | stringAUSSP, EINSP |
| lokationsadresse | Angabe des Ortes, Postleitzahl, Ländercode, Straße, Hausnummer, Hausnummernergänzung der Marktlokationsadresse | Mapping auf identificationParameterAddress | object |
postleitzahl | Postleitzahl | string |
ort | Ort | string |
strasse | Strasse | string |
hausnummer | Hausnummer und Ergänzung | string |
postfach | Postfach | string |
adresszusatz | Adresszusatz | string |
coErgaenzung | coErgaenzung | string |
landescode | Landescode | stringAC, AD, AE AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, YU, ZA, ZM, ZR, ZW |
ortsteil | Ortsteil | string |
| zusatzInformation | Zusatzinformation zur Identifizierung, Zeile für Name und Anschrift | object |
zusatz1 | Adresszusatz 1 | string |
zusatz2 | Adresszusatz 2 | string |
zusatz3 | Adresszusatz 3 | string |
zusatz4 | Adresszusatz 4 | string |
zusatz5 | Adresszusatz 5 | string |
| katasterinformation | Angabe des Gemarkungsnamens, Flurnummer, Flurstücksnummer (des Flurstücks) der Marktlokationsadresse | Mapping auf identificationParameterAddress.landParcels | object |
gemarkung_flur | Gemarkung Flur | string |
flurstueck | Flurstück Name | string |
flurstueckNummer | Flurstück Nummer | string |
| geokoordinaten | Angabe der Breite (Breitengrad), Angabe der Breite (Breitengrad), UTM Ostwert, UTM Nordwert, Gauß-Krüger Hochwert, Gauß-Krüger Rechtswert | Mapping auf identificationParameterAddress.geographicCoordinates | object |
breitengrad | Gibt den Breitengrad eines entsprechenden Ortes an. | string |
laengengrad | Gibt den Längengrad eines entsprechenden Ortes an. | string |
ostwert | Gibt den Ostwert eines entsprechenden Ortes an. | string |
nordwert | Gibt den Nordwert eines entsprechenden Ortes an. | string |
zone | UTM Zone 31, 32, 33 | stringUTMZone31, UTMZone32, UTMZone33 |
hochwert | Gibt den Hochwert eines entsprechenden Ortes an. | string |
rechtswert | Gibt den Rechtswert eines entsprechenden Ortes an. | string |
| TRANCHE[ ] | — | object[] |
boTyp* | — | stringTRANCHE |
versionStruktur* | — | string1 |
tranchenId | Identifiziert die Tranche mittels einer eindeutigen ID | Mapping auf identificationParameterId.tranchenIds | string |
| MESSLOKATION[ ] | — | object[] |
boTyp* | — | stringMESSLOKATION |
versionStruktur* | — | string1 |
messlokationsId | Identifiziert die Messlokation mittels einer eindeutigen ID | Mapping auf identificationParameterId.meloIds | string |
| ZAEHLER[ ] | — | object[] |
boTyp* | — | stringZAEHLER |
versionStruktur* | — | string1 |
zaehlernummer | Identifiziert das Gerät der Messlokation mittels Gerätenummer | Mapping auf identificationParameterId.meterNumbers | string |
| ENERGIELIEFERVERTRAG[ ] | — | object[] |
boTyp* | — | stringVERTRAG |
versionStruktur* | — | string1 |
vertragsart | — | stringENERGIELIEFERVERTRAG |
| vertragspartner2[ ] | — | object[] |
boTyp | — | stringGESCHAEFTSPARTNER |
versionStruktur | — | string1 |
anrede | Angabe des Titels der natürlichen Person | Mapping auf identificationParameterAddress.name.title | string |
name1 | Angabe des Namen des Kunden | Mapping auf identificationParameterAddress.name.surnames oder identificationParameterAddress.name.company, wenn gewerbekennzeichnung = true | string |
name2 | Angabe des Vornamen des Kunden | Mapping auf identificationParameterAddress.name.firstnames | string |
gewerbekennzeichnung | Angabe ob gewerblicher oder private Kunde | boolean |
geschaeftspartnerrolle[ ] | — | string[]KUNDE |
| externeReferenzen[ ] | Zur Angabe der Kundennummer des Kunden beim bisherigen Lieferanten (LFA) | object[] |
exRefName | — | stringKundennummer beim Altlieferanten |
exRefWert | Kundennummer des Kunden beim bisherigen Lieferanten (LFA) | string |
| transaktionsdaten* | Informationscontainer für Daten zum Vorgang und beteiligten Marktpartnern | object |
vorgangsnummer* | Externe Transaktions-Id zur eindeutigen Identifikation der Anfrage der MaLo-ID der Marktlokation des sendenden Marktpartners. | Format $UUID RFC4122 | Mapping auf [header] transactionId | string |
nachrichtendatum | Zeitpunkt an dem der Aufruf erstellt wurde in Zeitzone UTC - falls der Wert aus dem Backend nicht befüllt ist, wird die MaloIdent Lösung das Datum zum Zeitpunkt des Empfang befüllen. | Format YYYY-MM-DD'T'HH:mm:ss'Z' | Mapping auf [header] creationDateTime | string |
ausfuehrungsdatum* | Zeitpunkt zu dem die Identifikation stattfinden soll in angegeben in Zeitzone UTC. (umgerechnet muss dieser Zeitpunkt ein Tagesbeginn 00:00 Uhr gesetzlicher deutscher Zeit sein) | Format YYYY-MM-DD'T'HH:mm:ss'Z' | Mapping auf identificationDateTime | string |
idempodenzschluessel | Initiale Vorgangsnummer (Format $UUID RFC4122) zur Angabe des Idempodenzschlüssel im Falle eines Retry aus dem Backend | Format $UUID RFC4122 | Mapping auf [header] initialTransactionId | string |
| absender* | Eigene ILN und Rollencodetyp | object |
rollencodenummer* | Eigene ILN | string |
| empfaenger* | ILN und Rollencodetyp des Netzbetreibers, an den die Identanfrage gestellt werden soll | object |
rollencodenummer* | ILN des Netzbetreibers, an den die Identanfrage gestellt werden soll | string |
Identifizierung der MaLo › Responses
Erfolg | Success
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
| maloIdentDaten[ ]* | Liste von Treffern der Maloident-Suche | object[] |
lokationsId* | Die ID der Marktlokation | string |
trefferMaloid* | Gibt an, ob primäres Trefferkriterium MaloId ein Treffer war. Die Übereinstimmung der MaLo-ID liegt vor, wenn die vollständige, 11-stellige Zeichenkette übereinstimmt. | boolean |
trefferTrancheId* | Gibt an, ob primäres Trefferkriterium TrancheId ein Treffer war. Die Prüfung ist für jede angegebene Tranchen-ID durchzuführen. Die Übereinstimmung der Tranchen-ID liegt vor, wenn die vollständige 11-stellige Zeichenkette übereinstimmt. | boolean |
trefferAdresse1* | -Gibt an, ob primäres Trefferkriterium Adresse1 ein Treffer war Die zu prüfende Adresse der Marktlokation besteht aus Straße, Hausnummer/Hausnummernergänzung, PLZ, Ort und Ländercode. · Bei Marktlokationen ohne zugeordnete Adressdaten kann zudem über das Tupel bestehend aus Gemarkung, Flurnummer und Flurstücknummer identifiziert werden. · Es kann auch eine Identifizierung über geographische Koordinaten erfolgen. Bei der Adressprüfung gelten die folgenden Regeln: · Die Zeichenketten „straße“, „str.“ oder „strasse“ am Ende eines Straßennamens werden durch einen Stern „*“ ersetzt, um damit alle Straßen zu finden, deren Name mit den links vom Stern stehenden Buchstaben beginnen. Der Stern gilt somit als Platzhalter. | boolean |
trefferKundennummer* | Gibt an, ob primäres Trefferkriterium Kundennummer ein Treffer war. Übermittelt wird die Kundennummer des LFA. Die Übereinstimmung der Kundennummer liegt vor, wenn die Zeichenkette der Kundennummer, wie sie dem Kunden mitgeteilt wurde übereinstimmt. | boolean |
trefferName* | - Gibt an, ob primäres Trefferkriterium Name ein Treffer war. Der zu prüfende Name besteht bei natürlichen Personen aus dem Vor- und Nachnamen. Bei juristischen Personen aus dem Namen der Firma. Mindestens folgende Gegebenheiten sollten abgefangen werden: · Identifikation durch Vertauschen von Vor- und Nachnamen · Identifikation aus dem String "Vor- und Nachname" gegen jeweils Vor- und Nachname in beide Richtungen (z.B. für Kunden, die im Vor- und Nachnamen jeweils einen kompletten Namen eingetragen haben (Wohngemeinschaften)) · Angabe der Firmenbezeichnung wird gegen Vor- und Nachnamen sowie dem kompletten String aus "Vor- und Nachname" verglichen. · Angabe der Kundennummer wird gegen die Kundennummer des LFA verglichen. · Identifikation aus dem String "Vor- und Nachname" gegen jeweils Vor- und Nachname in beide Richtungen (z.B. für Kunden, die im Vor- und Nachnamen jeweils einen kompletten Namen eingetragen haben (Wohngemeinschaften)) · Angabe der Firmenbezeichnung wird gegen Vor- und Nachnamen sowie dem kompletten String aus "Vor- und Nachname" verglichen. | boolean |
trefferGeraetenummer* | - Gibt an, ob primäres Trefferkriterium Gerätenummer ein Treffer war. Die Prüfung ist für jede angegebene Gerätenummer durchzuführen. - Es sind alle Geräte vom Typ kME, mME und Smart-Meter-Gateways mit der übergebenen Gerätenummer zu suchen. - Die Reihenfolge der Zeichen in der Gerätenummer ist wichtig. - Bei einer Prüfung der Gerätenummer ist es wichtig, dass die Reihenfolge der Zeichen identisch ist. - Die Prüfung ist case-sensitiv. - Zusätzlich sind schließende Nullen ebenfalls zu ignorieren. - Dabei sind für jeden Zeichen in der Reihenfolge folgende Regeln zu beachten: - Zusammen mit schließenden Nullen werden auch alle Zeichen in der Reihenfolge berücksichtigt. - Eine Identifizierung soll auch erfolgen, wenn ein Marktpartner einen Zähler/Gateway sendet, der bereits im Rahmen eines Gerätewechsels innerhalb der letzten 36 Monate ausgetauscht wurde (Ausnahme Netzbetreiberwechsel). - Die Übereinstimmung einer Gerätenummer liegt vor, wenn alle Zeichen in genannter Reihenfolge mit der aufgebrachten Nummer auf dem Gerät identisch sind. - Gegebenenfalls im System vorhandene Prä- und Suffixe sind zu ignorieren. | boolean |
trefferMeloid* | Gibt an, ob primäres Trefferkriterium MeloId ein Treffer war. Die Prüfung ist für jede angegebene MeLo-ID durchzuführen. Die Übereinstimmung der MeLo-ID liegt vor, wenn die vollständige 33-stellige Zeichenkette übereinstimmt. | boolean |
trefferAdresse2* | Gibt an, ob sekundäres Trefferkriterium zweite Adresse ein Treffer war. Ermittlung, ob ermittelte Malo alle Adressidentifizierungsparameter erfüllt (Vollständige Adrressprüfung) | boolean |
trefferMakorelevant* | Gibt an, ob sekundäres Trefferkriterium Makorelevanz ein Treffer war. Ermittlung, ob ermittelte Malo an der Mako teilnimmt | boolean |
trefferStillgelegt* | Gibt an, ob sekundäres Trefferkriterium Stilllegungsstatus ein Treffer war. Ermittlung, ob ermittelte Malo stillgelegt ist. | boolean |
trefferNetzgebiet* | Gibt an, ob sekundäres Trefferkriterium Netzgebiet ein Treffer war. Ermittlung, ob ermittelte Malo zum Selektionszeitpunkt einem Netz zugeordnet ist, welches durch eine Serviceanbieter mit Kennzeichen „eigener Service“ versorgt wird. | boolean |
trefferNetzgebiet3KJ* | Gibt an, ob sekundäres Trefferkriterium 3KJ-Netzgebiet ein Treffer war.Ermittlung, ob ermittelte Malo zum innerhalb der letzten 3 KJ einem Netz zugeordnet ist oder war, welches durch eine Serviceanbieter mit Kennzeichen „eigener Service“ versorgt wird. | boolean |