WiM -> iMSB
ConfigurationConfirmationBIP
BackendIntegrationPoint
Key TODO
com.nextlevel.bpm.level2.wim.smart.energy.ConfigurationConfirmationBIP
RemoteSystem->Webservice
ConfigurationConfirmationBIP
http://<server>:<port>/myBusinessSupplier/interface/order-configuration-confirmation
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
TODO
}
ResponseBody (Beispiel)
{
TODO
}
LocationCheckBIP
BackendIntegrationPoint
Start_NLIRIP020_Meldepunkt akzeptieren/ablehnen
com.nextlevel.wim.ara.LocationCheckBIP
RemoteSystem->Webservice
LocationCheckBIP
http://<server>:<port>/myBusinessSupplier/interface/locationCheckResponse
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"location":"DE111222333",
"partnerILN":"9999999999999",
"terminationDate":"2018-06-30T00:00:00+02:00"
}
ResponseBody (Beispiel)
{
"decision":"accepted",
"reason":""
}
Feld “reason” ist nur bei einer Ablehnung ein Pflichtfeld und muss den Ablehnungsgrund aus dem APERAK AHB enthalten.
SendPriceSheetBIP
Zur Übermittlung von Preisblättern ans iMSB im Zuge des Prozesses “Preisblattkatalog versenden”.
BackendIntegrationPoint
Start_NLIPRI010_iMSB-Anbindung
com.nextlevel.wim.imsb.SendPriceSheetBIP
RemoteSystem->Webservice
SendPriceSheetBIP
http://<server>:<port>/myBusinessSupplier/interface/setPricePaper
Benutzer
Passwort Base64 verschlüsselt
RequestBody (PriceSheet aus Platform Projekt edi.util) (Beispiel)
{
"ownIln" : "9900000000000",
"sentDate" : "2020-07-24T16:38:43.528+02:00",
"name" : "PBK-Standard",
"version" : 2,
"validFrom" : "2020-01-01T00:00:00.000+01:00",
"priceSheetEntries" : [ {
"articleNumber" : "9990001000798",
"priceKeyBase" : "PBK-Standard-2-Z26-Z11-BSW",
"format" : null,
"product" : "Z26",
"voltage" : "Z11",
"description" : "BSW",
"price" : 998
}, {
"articleNumber" : "9990001000798",
"priceKeyBase" : "PBK-Standard-2-Z27-Tarifschaltuhr",
"format" : null,
"product" : "Z27",
"voltage" : null,
"description" : "Tarifschaltuhr",
"price" : 400
} ]
}
CheckRequestInvoiceProcedureBIP
BackendIntegrationPoint
Start_NLIRIP020_Prüfen der Anfrage
com.nextlevel.wim.ara.CheckRequestInvoiceProcedureBIP
RemoteSystem->Webservice
CheckRequestInvoiceProcedureBIP
http://<server>:<port>/myBusinessSupplier/interface/checkRequestInvoiceProcedureResponse
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"marketLocation":"DE111222333",
"partnerILN":"9999999999999",
"terminationDate":"2018-06-30T00:00:00+02:00"
}
ResponseBody (Beispiel)
{
"decision":"accepted",
"reason":""
}
Feld “reason” ist nur bei einer Ablehnung ein Pflichtfeld und muss den Ablehnungsgrund aus dem IFTSTA AHB enthalten.
EndInvoiceProcedureResponseBIP
Antwort auf die Anfrage zur Beendigung der Rechnungsabwicklung durch den Lieferanten.
BackendIntegrationPoint
Start_NLIEIP030_Mitteilung
com.nextlevel.wim.eip.EndInvoiceProcedureResponseBIP
RemoteSystem->Webservice
EndInvoiceProcedureResponseBIP
http://<server>:<port>/myBusinessSupplier/interface/receiveEndInvoiceProcedureResponse
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"meteringPoint":"DE111222333",
"executionDate":"2018-06-30T00:00:00+02:00",
"isAccepted":"true",
"reason": "Antwort code aus EDIFACT"
}
EndInvoiceProcedureBIP
Use Case
Die Abbrechnung der Messstelle über den Lieferant wird vom Lieferanten beendet. Der BIP beendet die Rechnungsabwicklung über den Lieferanten für den Vertrag. Dies führt zur Beendigung des Vertrags zum angegebenen Datum und der Erstellung eines Folgevertrags mit Beginn am Folgetag, welcher durch den MSB abgerechnet wird.
BackendIntegrationPoint
Start_NLIEIP020_Prüfung der Anfrage_1
com.nextlevel.wim.eip.EndInvoiceProcedureBIP
RemoteSystem->Webservice
EndInvoiceProcedureBIP
http://<server>:<port>/myBusinessSupplier/interface/endInvoiceProcedure
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"marketLocation":"DE111222333",
"partnerILN":"9999999999999",
"terminationDate":"2018-06-30T00:00:00+02:00"
}
ResponseBody (Beispiel)
{
"decision":"accepted",
"reason": "Z13"
}
Feld Decision: “accepted” wenn Beendigung der Rechnungsabwicklung möglich, sonst “declined”. Feld Resaon: Mögliche Werte: “Z64”: Beendigungsdatum ist nicht vertragskonform, “Z51”: LF ist nicht Zahler des Messstellenbetriebs, “Z13”: Zustimmung ohne Korrekturen
RequestQuotesBIP
BackendIntegrationPoint
Start_NLIRIP020_Erstelle Angebot
com.nextlevel.wim.ara.RequestQuotesBIP
RemoteSystem->Webservice
RequestQuotesBIP
http://<server>:<port>/myBusinessSupplier/interface/getQuotesData
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"marketLocation":"50000000000",
"partnerILN":"4000000000000",
"terminationDate":"2018-06-30T00:00:00+02:00",
"terminationDateQualifier":"469",
"quotesDocumentNumber":"W165616643156",
"wimProcessId":"4057b680-4d2d-11ec-8769-083a885950fd"
}
QuotesResponseBIP
QuotesResponseBIP und ResponseInvoiceProcedureBIP kommen sich in die Quere, nur einen verwenden. Klären welcher verwendet werden soll.
BackendIntegrationPoint
Start_NLIRIP030_Mitteilung
com.nextlevel.wim.ara.QuotesResponseBIP
RemoteSystem->Webservice
QuotesResponseBIP
http://<server>:<port>/myBusinessSupplier/interface/receiveQuotesResponse
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"marketLocation":"DE111222333",
"reference":"W1234",
"terminationDate":"2018-06-30T00:00:00+02:00",
"decision":"accepted",
"reason":""
}
“reason” ist ein optionales Feld.
ResponseInvoiceProcedureBIP
QuotesResponseBIP und ResponseInvoiceProcedureBIP kommen sich in die Quere, nur einen verwenden. Klären welcher verwendet werden soll.
BackendIntegrationPoint
Start_NLIRIP030_Mitteilung
com.nextlevel.wim.rip.ResponseInvoiceProcedureBIP
RemoteSystem->Webservice
StartInvoiceProcedureResponse
http://<server>:<port>/myBusinessSupplier/interface/receiveInvoiceProcedureResponse
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"accepted":"true",
"meteringPoint":"DE123",
"executionDate":"2018-06-30T00:00:00+02:00",
"quotesRef":"W1234"
}
Rahmenverträge bei Angebot Rechnungsabwicklung
In den Stammdaten der WiM kann man am Marktpartner Informationen zum Rahmenvertrag mit dem jeweiligen Marktpartner hinterlegen. Dabei gibt es fünf Möglichkeiten: es leer lassen, nicht vorhanden, vorhanden, vorhanden AR immer zustimmen und vorhanden AR immer abhlehnen. Bei den ersten drei Möglichkeiten verhält sich der Prozess Angebot Rechnungsabwicklung “normal” und es wird das Angbeot wie gewohnt verschickt. Bei den letzten beiden Möglichkeiten wird das Angebot nicht an den Lieferanten verschickt und man kann über folgenden BIP die am Martkpartner ausgewählte Antwort direkt an das iMSB zurückgeben.
BackendIntegrationPoint
Start_NLIRIP010_Mitteilung
com.nextlevel.wim.rip.ResponseInvoiceProcedureBIP
RemoteSystem->Webservice
StartInvoiceProcedureResponse
http://<server>:<port>/myBusinessSupplier/interface/receiveInvoiceProcedureResponse
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"accepted":"true",
"meteringPoint":"DE123",
"executionDate":"2018-06-30T00:00:00+02:00",
"quotesRef":"W1234"
}
Stammdatenänderung
Es können Stammdaten von eingehende Stammdatenänderungen von Marktpartnern, Stammdatenänderungen aus dem MBSE oder Stammdaten aus anderen Prozessen an das iMSB weitergeleitet werden. Neben den drei unten aufgeführten Stellen können die genannten BIPs auch noch an anderen Stellen eingesetzt werden.
BackendIntegrationPoint
End_NLISDA010_Stammdatenänderung Senden
com.nextlevel.bpm.level2.wim.smart.energy.SendMasterDataBIP
Start_NLISDA020_Änderungsmitteilung
com.nextlevel.bpm.level2.wim.smart.energy.SendMasterDataBIP
End_NLIROL020_Verarbeite neue Stammdaten
com.nextlevel.bpm.level2.wim.smart.energy.SendMasterDataBIP
RemoteSystem->Webservice
SendMasterDataBIP
http://<server>:<port>/myBusinessSupplier/interface/masterDataChange
Benutzer
Passwort Base64 verschlüsselt
BackendIntegrationPoint
Start_NLIROL040_Übergabe an iMSB
com.nextlevel.bpm.level2.wim.smart.energy.SendMasterDataImportBIP
RemoteSystem->Webservice
SendMasterDataImportBIP
http://<server>:<port>/myBusinessSupplier/interface/masterDataImport
Benutzer
Passwort Base64 verschlüsselt
RequestBody ist ein MasterdataVo (Platform Projekt edi.util).
MSB Wechsel
BackendIntegrationPoint
Start_NLI010060_Mitteilung
com.nextlevel.wim.imsb.MsbChangeBIP
Start_NLI010099_Mitteilung
com.nextlevel.wim.imsb.MsbChangeBIP
Start_NLI050050_Mitteilung
com.nextlevel.wim.imsb.MsbChangeBIP
RemoteSystem->Webservice
MsbChangeBIP
http://<server>:<port>/myBusinessSupplier/interface/changeOperator
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"meteringPoint":"DE111222333444555",
"executionDate":"2018-06-30T00:00:00+02:00",
"partnerILN":"9999999999999",
"comment":"",
}
LF Wechsel
BackendIntegrationPoint
com.nextlevel.wim.imsb.LfChangeBIP
RemoteSystem->Webservice
LfChangeBIP
http://<server>:<port>/myBusinessSupplier/interface/supplierChange
Benutzer
Passwort Base64 verschlüsselt
RequestBody (Beispiel)
{
"meteringPoint":"DE111222333444555",
"executionDate":"2018-06-30T00:00:00+02:00",
"partnerILN":"9999999999999",
"comment":"",
}
iMSB Migration / Rollout
BackendIntegrationPoint
Start_NLIROL030_Information über erfolgreichen Gerätewechsel
com.nextlevel.bpm.level2.wim.smart.energy.MigrateMarketLocationBIP
Start_NLIROL040_Übergabe an iMSB
com.nextlevel.bpm.level2.wim.smart.energy.MigrateMarketLocationBIP
RemoteSystem->Webservice
MigrateMarketLocationBIP
http://<server>:<port>/myBusinessSupplier/interface/migrateMarketLocation
Benutzer
Passwort Base64 verschlüsselt
BackendIntegrationPoint
End_NLIROL030_Starte Einbau_4
com.nextlevel.wim.imsb.SendBusinessPartnersInfoBIP
RemoteSystem->Webservice
SendBusinessPartnersInfoBIP
http://<server>:<port>/myBusinessSupplier/interface/createAndSendPreLetterDocuments
Benutzer
Passwort Base64 verschlüsselt
iMSB -> WiM
Die von der WiM zur Verfügung gestellten REST-Services sind unter folgenden URLs erreichbar:
RequestInvoiceProcedure
http://<server>:<port>/fastlane-backend/interface/startRequestInvoiceProcedure
Es handelt sich um einen POST Aufruf, der folgenden RequestBody erwartet (Beispiel):
{
"marketLocation": "50000000000",
"ownILN": "9900000000000",
"partnerILN": "4000000000000",
"reason": "Z33",
"terminationDate": "2020-08-01T00:00:00",
"contactPerson" : {
"name" : "Mustermann",
"address" : "max@mustermann",
"addressTypeCode" : "EM"
},
"deliveryAddress": {
"plz": "01234",
"city": "Musterhausen",
"street": "Musterstraße 22",
"housenumber": "22 A"},
"products": [
{"product":"Z25"},
{"product":"Z26","voltage":"Z10"}
]
}
EndInvoiceProcedure
http://<server>:<port>/fastlane-backend/interface/endInvoiceProcedure
Es handelt sich um einen POST Aufruf, der folgenden RequestBody erwartet (Beispiel):
{
"marketLocation":"DE111222333",
"ownILN":"9999999999998",
"partnerILN":"9999999999999",
"terminationDate":"2018-06-30T00:00:00",
"deliveryAddress":{"plz":"12345","city":"Musterstadt","street":"Musterstraße","housenumber":"10"}
}
receiveQuotesData
http://<server>:<port>/fastlane-backend/interface/receiveQuotesData
Diese Schnittstelle ist die Antwort des iMSB auf QuotesResponseBIP Es handelt sich um einen POST Aufruf, der folgenden RequestBody erwartet (Beispiel):
{
"marketLocation" : "50000000000",
"ownILN" : "9900000000000",
"partnerILN" : "9900000000009",
"reason" : "Z33",
"terminationDate" : "2020-06-01T00:00:00.000+02:00",
"contractEnd" : null,
"deliveryAddress" : {
"plz" : "99999",
"city" : "Musterhausen",
"street" : "Musterweg Weg",
"housenumber" : "22"
},
"products" : [ {
"product" : "Z25",
"voltage" : null
} ],
"contactPerson" : {
"name" : "MSB",
"address" : "msb@msb.de",
"addressTypeCode" : "EM"
},
"wimProcessId" : "4057b680-4d2d-11ec-8769-083a885950fd"
Preis Anfrage aus Preisblättern
http://<server>:<port>/fastlane-backend/interface/getPrice
HTTP GET-Aufruf, folgende möglichen Parameter:
Attribut | Datentyp | Pflichtfeld | Beschreibung |
---|---|---|---|
ownILN | String | X | Eigene ILN |
partnerILN | String | X (1) | ILN des Marktpartners (1) Muss wahrscheinlich nicht angegeben werden |
product | String | X | POG Wertelist: Z15, Z16, Z17, Z18, Z19, Z20, Z21, Z22, Z23, Z24, Z25, Z28, Z29, Z30, Z31, Z32, Z26, Z27 |
voltage | String | X (2) | Spannungsebene (2) nur wenn product=Z26 |
description | String | (3) | Produkt-/Leistungsbeschreibung (3) vielleicht notwendig wenn product=Z26 oder product=Z27 |
terminationDate | Date | X | Gültigkeitsdatum in ISO 8601 |
Antwort auf GET Anfrage mit Payload als Media Type “application/json”:
Attribut | Datentyp | Pflichtfeld | Beschreibung |
---|---|---|---|
price | String | X | Preis in Euro Bsp.: 1.20 |
priceKey | String | Preisschlüsselstamm Segment PIA aus PRICAT |
Wird kein Preis zu den verwendeten Parametern gefunden wird, wird der Status 400 (Bad Request) zurückgeliefert.