Reading backend interfaces
Identification of the MaLo
Identification of the MaLo
POST
https://mock.macoapp.de
/identifyMarketlocation
LESEN_MALOIDENT_BASIS
Transfers the data for identifying all market locations in accordance with process description, as well as all information for carrying out the EBD E_0594.
Identification of the MaLo › Request Body
| Structure (BO4E) | Description | Format |
|---|---|---|
| stammdaten* | Information container for master data used for identification | object |
| MARKTLOKATION[ ]* | — | object[] |
boTyp* | — | stringMARKTLOKATION |
versionStruktur* | — | string1 |
marktlokationsId | Identifies the market location by means of a unique ID | Mapping to identificationParameterId.maloId | string |
energierichtung* | Energy flow direction of the market location | Mapping to energyDirection | stringAUSSP, EINSP |
| lokationsadresse | City, postal code, country code, street, house number, house number suffix of the market location address | Mapping to identificationParameterAddress | object |
postleitzahl | Postal code | string |
ort | City | string |
strasse | Street | string |
hausnummer | House number and supplement | string |
postfach | PO box | string |
adresszusatz | Address supplement | string |
coErgaenzung | coErgaenzung | string |
landescode | Country code | 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 | District | string |
| zusatzInformation | Additional information for identification, line for name and address | object |
zusatz1 | Address supplement 1 | string |
zusatz2 | Address supplement 2 | string |
zusatz3 | Address supplement 3 | string |
zusatz4 | Address supplement 4 | string |
zusatz5 | Address supplement 5 | string |
| katasterinformation | Cadastral district name, land register number, parcel number (of the land parcel) of the market location address | Mapping to identificationParameterAddress.landParcels | object |
gemarkung_flur | Cadastral district, sector | string |
flurstueck | Land parcel name | string |
flurstueckNummer | Land parcel number | string |
| geokoordinaten | Specification of the latitude (degree of latitude), specification of the latitude (degree of latitude), UTM east value, UTM north value, Gauß-Krüger northing, Gauß-Krüger easting | Mapping to identificationParameterAddress.geographicCoordinates | object |
breitengrad | States the latitude of a corresponding location. | string |
laengengrad | States the longitude of a corresponding location. | string |
ostwert | States the east value of a corresponding location. | string |
nordwert | States the north value of a corresponding location. | string |
zone | UTM zone 31, 32, 33 | stringUTMZone31, UTMZone32, UTMZone33 |
hochwert | States the northing of a corresponding location. | string |
rechtswert | States the easting of a corresponding location. | string |
| TRANCHE[ ] | — | object[] |
boTyp* | — | stringTRANCHE |
versionStruktur* | — | string1 |
tranchenId | Identifies the tranche by means of a unique ID | Mapping to identificationParameterId.tranchenIds | string |
| MESSLOKATION[ ] | — | object[] |
boTyp* | — | stringMESSLOKATION |
versionStruktur* | — | string1 |
messlokationsId | Identifies the metering location by means of a unique ID | Mapping to identificationParameterId.meloIds | string |
| ZAEHLER[ ] | — | object[] |
boTyp* | — | stringZAEHLER |
versionStruktur* | — | string1 |
zaehlernummer | Identifies the device of the metering location by means of the device number | Mapping to identificationParameterId.meterNumbers | string |
| ENERGIELIEFERVERTRAG[ ] | — | object[] |
boTyp* | — | stringVERTRAG |
versionStruktur* | — | string1 |
vertragsart | — | stringENERGIELIEFERVERTRAG |
| vertragspartner2[ ] | — | object[] |
boTyp | — | stringGESCHAEFTSPARTNER |
versionStruktur | — | string1 |
anrede | Title of the natural person | Mapping to identificationParameterAddress.name.title | string |
name1 | Name of the customer | Mapping to identificationParameterAddress.name.surnames or identificationParameterAddress.name.company if gewerbekennzeichnung = true | string |
name2 | First name of the customer | Mapping to identificationParameterAddress.name.firstnames | string |
gewerbekennzeichnung | Indicates whether commercial or private customer | boolean |
geschaeftspartnerrolle[ ] | — | string[]KUNDE |
| externeReferenzen[ ] | For specifying the customer number of the customer at the previous supplier (LFA) | object[] |
exRefName | — | stringKundennummer beim Altlieferanten |
exRefWert | Customer number of the customer at the previous supplier (LFA) | string |
| transaktionsdaten* | Information container for data on the case and the market partners involved | object |
vorgangsnummer* | External transaction ID for the unique identification of the request for the MaLo-ID of the market location of the sending market partner. | Format $UUID RFC4122 | Mapping to [header] transactionId | string |
nachrichtendatum | Point in time at which the call was created, in time zone UTC - if the value from the backend is not filled, the MaloIdent solution fills in the date at the time of receipt. | Format YYYY-MM-DD'T'HH:mm:ss'Z' | Mapping to [header] creationDateTime | string |
ausfuehrungsdatum* | Point in time at which the identification is to take place, given in time zone UTC. (converted, this point in time must be the start of a day at 00:00 German legal time) | Format YYYY-MM-DD'T'HH:mm:ss'Z' | Mapping to identificationDateTime | string |
idempodenzschluessel | Initial transaction number (format $UUID RFC4122) for specifying the idempotency key in the event of a retry from the backend | Format $UUID RFC4122 | Mapping to [header] initialTransactionId | string |
| absender* | Own ILN and role code type | object |
rollencodenummer* | Own ILN | string |
| empfaenger* | ILN and role code type of the grid operator to which the ident request is to be sent | object |
rollencodenummer* | ILN of the grid operator to which the ident request is to be sent | string |
Identification of the MaLo › Responses
Success | Success
| Structure (BO4E) | Description | Format |
|---|---|---|
| maloIdentDaten[ ]* | List of hits from the Maloident search | object[] |
lokationsId* | The ID of the market location | string |
trefferMaloid* | Indicates whether the primary match criterion MaloId was a match. The MaLo-ID matches if the complete, 11-digit character string is identical. | boolean |
trefferTrancheId* | Indicates whether the primary match criterion TrancheId was a match. The check must be carried out for each tranche ID specified. The tranche ID matches if the complete 11-digit character string is identical. | boolean |
trefferAdresse1* | -Indicates whether the primary match criterion address1 was a match The address of the market location to be checked consists of street, house number/house number suffix, PLZ, city and country code. · For market locations without assigned address data, identification can additionally be made via the tuple consisting of cadastral district, field number and parcel number. · Identification via geographic coordinates is also possible. The following rules apply to the address check: · The character strings „straße“, „str.“ or „strasse“ at the end of a street name are replaced by an asterisk „*“ in order to find all streets whose name begins with the letters to the left of the asterisk. The asterisk thus acts as a wildcard. | boolean |
trefferKundennummer* | Indicates whether the primary match criterion customer number was a match. The customer number of the LFA is transmitted. The customer number matches if the character string of the customer number as communicated to the customer is identical. | boolean |
trefferName* | - Indicates whether the primary match criterion name was a match. For natural persons the name to be checked consists of the first name and the surname. For legal persons, of the name of the company. At least the following circumstances should be caught: · Identification by swapping first name and surname · Identification from the string "first name and surname" against first name and surname in both directions (e.g. for customers who have entered a complete name in both the first name and the surname (shared flats)) · The company designation given is compared against first name and surname as well as against the complete string of "first name and surname". · The customer number given is compared against the customer number of the LFA. · Identification from the string "first name and surname" against first name and surname in both directions (e.g. for customers who have entered a complete name in both the first name and the surname (shared flats)) · The company designation given is compared against first name and surname as well as against the complete string of "first name and surname". | boolean |
trefferGeraetenummer* | - Indicates whether the primary match criterion device number was a match. The check is to be carried out for every device number specified. - All devices of type kME, mME and smart meter gateways with the transmitted device number are to be searched for. - The order of the characters in the device number matters. - When checking the device number it is important that the order of the characters is identical. - The check is case-sensitive. - In addition, trailing zeros are likewise to be ignored. - The following rules are to be observed for each character in the order: - Together with trailing zeros, all characters in the order are also taken into account. - Identification shall also take place if a market partner sends a meter/gateway that has already been replaced in the course of a device exchange within the last 36 months (exception: grid operator change). - A device number matches if all characters in the stated order are identical to the number applied on the device. - Any prefixes and suffixes present in the system are to be ignored. | boolean |
trefferMeloid* | Indicates whether the primary match criterion MeloId was a match. The check must be carried out for each MeLo-ID specified. The MeLo-ID matches if the complete 33-digit character string is identical. | boolean |
trefferAdresse2* | Indicates whether the secondary match criterion second address was a match. Determination of whether the identified Malo fulfils all address identification parameters (complete address check) | boolean |
trefferMakorelevant* | Indicates whether the secondary match criterion Mako relevance was a match. Determination of whether the identified Malo takes part in the Mako | boolean |
trefferStillgelegt* | Indicates whether the secondary match criterion decommissioning status was a match. Determination of whether the identified Malo is decommissioned. | boolean |
trefferNetzgebiet* | Indicates whether the secondary match criterion grid area was a match. Determination of whether the identified Malo is assigned at the time of selection to a grid supplied by a service provider with the indicator "own service". | boolean |
trefferNetzgebiet3KJ* | Indicates whether the secondary match criterion 3KJ grid area was a match. Determination of whether the identified Malo is or was assigned within the last 3 calendar years to a grid supplied by a service provider with the indicator "own service". | boolean |