REST Prozess Start
Starten von Prozessen über REST-Schnittstelle
Das Starten von Prozessen kann neben dem CSV-Upload auch über eine REST-Schnittstelle durchgeführt werden. Das Format orientiert sich bei den REST-Services am Aufbau des CSV-Formats des Prozessuploads. Der Request wird asynchron verarbeitet und die Objekte werden als JSON kodiert. Der Content-Type des Ergebnisses ist application/json.
Der RestService ist unter folgender URL zu erreichen:
http://<server>:<port>/fastlane-backend/interface/startProcessRest
bzw.
https://<server>:<port>/fastlane-backend/interface/startProcessRest
Für VNBs ist es i.d.R. nicht notwendig selber Prozesse anzustoßen, da bei ihm Prozesse durch das Eintreffen der EDIFACT-Nachrichten von anderen Marktpartnern gestartet werden.
Wichtig ist, dass die genaue Angabe von Pflichtfeldern in der Dokumentation nicht möglich ist. Um herauszufinden, wann welches Feld genau ein Pflichtfeld oder optional ist, prüfen Sie bitte das entsprechende AHB!
Parameter
{
"group": null,
"externalId": null,
"processName": null,
"processPart": null,
"processStep": null,
"processInstance": null,
"meteringNr": null,
"meteringPoint": null,
"ownILN": null,
"partnerILN": null,
"created": null,
"terminationDate": null,
"type": null,
"reason": null,
"currentStatus": null,
"statusShortText": null,
"referenceNr": null,
"transactionNr": null,
"defectType": null,
"defectMessage": null,
"obisNumberRequest": null,
"dateFrom": null,
"dateTo": null,
"name": null,
"firstname": null,
"street": null,
"housenumber": null,
"floor": null,
"city": null,
"plz": null,
"personcompany": null,
"alternativeStreet": null,
"alternativeHousenumber": null,
"alternativeCity": null,
"alternativePlz": null,
"infoIdentification": null,
"nameReadoutCard": null,
"firstNameReadoutCard": null,
"structureReadoutCard": null,
"streetReadoutCard": null,
"houseNumberReadoutCard": null,
"cityReadoutCard": null,
"plzReadoutCard": null,
"contactPerson": null,
"contactText": null,
"contactType": null,
"meterManufacturer": null,
"meterInfo": null,
"meterType": null,
"mpContactTitle": null,
"mpContactFirstname": null,
"mpContactLastname": null,
"mpContactCompany": null,
"mpContactStreet": null,
"mpContactHousenumber": null,
"mpContactPlz": null,
"mpContactCity": null,
"tsnReadoutType": null,
"tsnObisCodeList": null,
"mpBuilding": null,
"mpFloor": null,
"mpRoom": null,
"mpLocDescription": null,
"meterMedium": null,
"mpContactPhone": null,
"mpContactMobile": null,
"mpContactEmail": null,
"mpContactFax": null,
"favoriteName": null
}
| Feld | Muss | Beispiel | Erklärung |
|---|---|---|---|
| group | ABC555 | Zusammenfassen von Prozessen zu einer Gruppe. Keine Auswirkung auf den Prozess. Reines Monitoringwerkzeug. | |
| externalId | 12345 | ID aus dem aufrufenden System. Keine Auswirkung auf den Prozess. Reines Monitoringwerkzeug. | |
| processName | X | Anmeldung | Gibt an welcher Prozess gestartet werden soll. “Anmeldung”=BeginMessstellenbetrieb |
| city | München | Lieferanschrift Stadt | |
| plz | 33332 | Lieferanschrift Postleitzahl | |
| street | Musterstraße | Lieferanschrift Straße | |
| housenumber | 55a | Lieferanschrift Hausnummer | |
| meteringNr | X(1) | 4715G | Zählernummer (1) Nur Pflicht wenn kein Zählpunkt angegeben. |
| meteringPoint | X(2) | DE70081333333MUST0000000000000209 | Zählpunktbezeichnung. (2) Nur Pflicht wenn keine Zählernummer angegeben. |
| terminationDate | X(3) | 2018-09-13T00:00:00 | Anmeldedatum=Gewünschtes Wechseldatum (3) Datumswerte in ISO 8601 Format |
| ownILN | X | 9910891000005 | Eigene MSBIln |
| partnerILN | X | 9900496000005 | Iln des Netzbetreiber |
| type | X | Z04 | Z04=Zu wechselnder Zähler wird analog ausgelesen. Z05=ist elektronisch ausgelesen. |
| reason | X | E03 | „E01“ für Ein-/Auszug(Umzug) oder „E02“ für „Einzug/Neuanlage“ oder „E03“ für Wechsel |
| name | X | Meier | Nachname des Letztverbrauchers |
| firstname | Christian | Vorname des Letztverbrauchers | |
| personcompany | X | Z01 | Letztverbraucher Person (Z01) oder Firma (Z02) |
| alternativeStreet | Hauptstraße | Letztverbraucher Straße | |
| alternativeHousenumber | 25-27 | Letztverbraucher Hausnummer | |
| alternativePlz | X | 44444 | Letztverbraucher Postleitzahl |
| alternativeCity | Köln | Letztverbraucher Stadt | |
| infoIdentification | Zähler befindet sich auf dem Dachboden! | Zusatzinformation für den Netzbetreiber | |
| nameReadoutCard | X(3) | Mustermann | Name auf Ablesekarte |
| firstNameReadoutCard | Max | Vorname auf Ablesekarte | |
| structureReadoutCard | Z01 | Person (Z01) oder Firma (Z02) auf Ablesekarte | |
| streetReadoutCard | Hauptstraße | Straße auf Ablesekarte | |
| houseNumberReadoutCard | 66b | Hausnummer auf Ablesekarte | |
| cityReadoutCard | Köln | Stadt auf Ablesekarte | |
| plzReadoutCard | 52066 | PLZ auf Ablesekarte |
Die Spalte personCompany kann mit Z01 für Person oder Z02 für Firma hinzufügt werden. Wird keine personCompany-Spalte angegeben, wird „Firma“ als Typ des Letztverbrauchers verwendet.
Folgende Parameter sind für den Start externer Prozesse vorgesehen:
meterManufacturer, meterInfo, meterType, mpContactTitle, mpContactFirstname, mpContactLastname, mpContactCompany, mpContactStreet, mpContactHousenumber, mpContactPlz, mpContactCity, tsnReadoutType, tsnObisCodeList, mpBuilding, mpFloor, mpRoom, mpLocDescription, meterMedium, mpContactPhone, mpContactMobile, mpContactEmail, mpContactFax
Wenn kein externer Prozess gestartet werden muss, sind diese zusätzlichen Parameter optional und sollten nicht befüllt werden.
Wenn z.B. ein TSN-Prozess gestartet werden muss, sind nur mpContactTitle und mpContactCompany der zusätzlichen Parameter optional und tsnObisCodeList ist optional, wenn ein BIP konfiguriert wird, der den Parameter überschreibt.
Wenn die Anbindung des Gerätemanagements aktiviert ist, kann zusätzlich der Parameter favoriteName angegeben werden, um die Auswahl des Favoriten zu überspringen.
Beginn Messtellenbetrieb
{
"group": "ABC555",
"processName": "Anmeldung",
"processPart": null,
"processStep": null,
"processInstance": null,
"meteringNr": "4715G",
"meteringPoint": "DE70081333333MUST0000000000000209",
"ownILN": "9910891000005",
"partnerILN": "9900496000005",
"created": null,
"terminationDate": "2018-09-13T00:00:00",
"type": "Z04",
"reason": "E03",
"currentStatus": null,
"statusShortText": null,
"referenceNr": null,
"transactionNr": null,
"defectType": null,
"defectMessage": null,
"obisNumberRequest": null,
"dateFrom": null,
"dateTo": null,
"name": "Meier",
"firstname": null,
"street": "Musterstraße",
"housenumber": "55a",
"floor": null,
"city": "München",
"plz": "33332",
"personcompany": "Z01",
"alternativeStreet": "Hauptstraße",
"alternativeHousenumber": "25-27",
"alternativeCity": "Köln",
"alternativePlz": "44444",
"infoIdentification": "Zähler befindet sich auf dem Dachboden!",
"nameReadoutCard": "Mustermann",
"firstNameReadoutCard": "Max",
"structureReadoutCard": "Z01",
"streetReadoutCard": "Hauptstraße",
"houseNumberReadoutCard": "66b",
"cityReadoutCard": "Köln",
"plzReadoutCard": "52066",
"contactPerson": null,
"contactText": null,
"contactType": null,
"meterManufacturer": null,
"meterInfo": null,
"meterType": null,
"mpContactTitle": null,
"mpContactFirstname": null,
"mpContactLastname": null,
"mpContactCompany": null,
"mpContactStreet": null,
"mpContactHousenumber": null,
"mpContactPlz": null,
"mpContactCity": null,
"tsnReadoutType": null,
"tsnObisCodeList": null,
"mpBuilding": null,
"mpFloor": null,
"mpRoom": null,
"mpLocDescription": null,
"meterMedium": null,
"mpContactPhone": null,
"mpContactMobile": null,
"mpContactEmail": null,
"mpContactFax": null,
"favoriteName": null
}
Ende Messtellenbetrieb
Wichtig ist, unter type anzugeben, ob es sich um einen elektronisch (Z05) oder analog (Z04) ausgelesenen Zähler handelt. Sonst kann bei elektronisch ausgelesenen Zählern im Gerätewechsel das Ausleseformular nicht richtig angezeigt werden (bei eZ muss der MSBA die Ausbauzählerstände erfassen!).
Beispiel:
{
"group": "Level1Test",
"processName": "EndeMSB",
"processPart": "NLI050010",
"processStep": null,
"processInstance": null,
"meteringNr": "4715G",
"meteringPoint": "DE70081333332MUST0000000000000008",
"ownILN": "9910518000007",
"partnerILN": "9900496000005",
"created": null,
"terminationDate": "2018-09-13T00:00:00",
"type": "Z05",
"reason": "E03",
"currentStatus": null,
"statusShortText": null,
"referenceNr": null,
"transactionNr": null,
"defectType": null,
"defectMessage": null,
"obisNumberRequest": null,
"dateFrom": null,
"dateTo": null,
"name": null,
"firstname": null,
"street": null,
"housenumber": null,
"floor": null,
"city": null,
"plz": null,
"personcompany": null,
"alternativeStreet": null,
"alternativeHousenumber": null,
"alternativeCity": null,
"alternativePlz": null,
"infoIdentification": null,
"nameReadoutCard": null,
"firstNameReadoutCard": null,
"structureReadoutCard": null,
"streetReadoutCard": null,
"houseNumberReadoutCard": null,
"cityReadoutCard": null,
"plzReadoutCard": null,
"contactPerson": null,
"contactText": null,
"contactType": null,
"meterManufacturer": null,
"meterInfo": null,
"meterType": null,
"mpContactTitle": null,
"mpContactFirstname": null,
"mpContactLastname": null,
"mpContactCompany": null,
"mpContactStreet": null,
"mpContactHousenumber": null,
"mpContactPlz": null,
"mpContactCity": null,
"tsnReadoutType": null,
"tsnObisCodeList": null,
"mpBuilding": null,
"mpFloor": null,
"mpRoom": null,
"mpLocDescription": null,
"meterMedium": null,
"mpContactPhone": null,
"mpContactMobile": null,
"mpContactEmail": null,
"mpContactFax": null,
"favoriteName": null
}
Kündigung Messstellenbetrieb
{
"group": "ABC555",
"processName": "Messstellenkuendigung",
"processPart": null,
"processStep": null,
"processInstance": null,
"meteringNr": "4715G",
"meteringPoint": "DE70081333333MUST0000000000000209",
"ownILN": "9910891000004",
"partnerILN": "9900496000005",
"created": null,
"terminationDate": "2018-09-13T00:00:00",
"type": "Z04",
"reason": null,
"currentStatus": null,
"statusShortText": null,
"referenceNr": null,
"transactionNr": null,
"defectType": null,
"defectMessage": null,
"obisNumberRequest": null,
"dateFrom": null,
"dateTo": null,
"name": "Mustermann",
"firstname": "Max",
"street": "Musterstraße",
"housenumber": "55a",
"floor": null,
"city": "München",
"plz": "33332",
"personcompany": "Z01",
"alternativeStreet": null,
"alternativeHousenumber": null,
"alternativeCity": null,
"alternativePlz": null,
"infoIdentification": "Zähler befindet sich auf dem Dachboden!",
"nameReadoutCard": null,
"firstNameReadoutCard": null,
"structureReadoutCard": null,
"streetReadoutCard": null,
"houseNumberReadoutCard": null,
"cityReadoutCard": null,
"plzReadoutCard": null,
"contactPerson": null,
"contactText": null,
"contactType": null,
"meterManufacturer": null,
"meterInfo": null,
"meterType": null,
"mpContactTitle": null,
"mpContactFirstname": null,
"mpContactLastname": null,
"mpContactCompany": null,
"mpContactStreet": null,
"mpContactHousenumber": null,
"mpContactPlz": null,
"mpContactCity": null,
"tsnReadoutType": null,
"tsnObisCodeList": null,
"mpBuilding": null,
"mpFloor": null,
"mpRoom": null,
"mpLocDescription": null,
"meterMedium": null,
"mpContactPhone": null,
"mpContactMobile": null,
"mpContactEmail": null,
"mpContactFax": null,
"favoriteName": null
}
Messstellenänderung
{
"group": "Level1Test",
"processName": "Messstellenänderung",
"processPart": "NLI060010",
"processStep": null,
"processInstance": null,
"meteringNr": null,
"meteringPoint": "DE70081333332MUST0000000000000009",
"ownILN": "9910891000004",
"partnerILN": "9900496000005",
"created": null,
"terminationDate": "2018-09-13T00:00:00",
"type": null,
"reason": null,
"currentStatus": null,
"statusShortText": null,
"referenceNr": null,
"transactionNr": null,
"defectType": null,
"defectMessage": null,
"obisNumberRequest": "1-1:1.8.1",
"dateFrom": null,
"dateTo": null,
"name": null,
"firstname": null,
"street": null,
"housenumber": null,
"floor": null,
"city": null,
"plz": null,
"personcompany": null,
"alternativeStreet": null,
"alternativeHousenumber": null,
"alternativeCity": null,
"alternativePlz": null,
"infoIdentification": null,
"nameReadoutCard": null,
"firstNameReadoutCard": null,
"structureReadoutCard": null,
"streetReadoutCard": null,
"houseNumberReadoutCard": null,
"cityReadoutCard": null,
"plzReadoutCard": null,
"contactPerson": "Herr Müller",
"contactText": "mueller@test.de",
"contactType": "EM",
"meterManufacturer": null,
"meterInfo": null,
"meterType": null,
"mpContactTitle": null,
"mpContactFirstname": null,
"mpContactLastname": null,
"mpContactCompany": null,
"mpContactStreet": null,
"mpContactHousenumber": null,
"mpContactPlz": null,
"mpContactCity": null,
"tsnReadoutType": null,
"tsnObisCodeList": null,
"mpBuilding": null,
"mpFloor": null,
"mpRoom": null,
"mpLocDescription": null,
"meterMedium": null,
"mpContactPhone": null,
"mpContactMobile": null,
"mpContactEmail": null,
"mpContactFax": null,
"favoriteName": null
}
Störungsmeldung
{
"group": "Level1Test",
"processName": "Störungsbehebung",
"processPart": "NLI070010",
"processStep": "1",
"processInstance": "14",
"meteringNr": "2144854",
"meteringPoint": "DE70081333332MUST0000000000000009",
"ownILN": "9910891000004",
"partnerILN": "9900496000005",
"created": "2018-09-13T00:00:00",
"terminationDate": "2018-09-13T00:00:00",
"type": null,
"reason": null,
"currentStatus": "UPLOAD",
"statusShortText": "Prozess hochgeladen",
"referenceNr": "1",
"transactionNr": "11",
"defectType": "Z11",
"defectMessage": "Fehler in der Kommunikationseinrichtung",
"obisNumberRequest": null,
"dateFrom": null,
"dateTo": null,
"name": null,
"firstname": null,
"street": "Im Zollhafen",
"housenumber": "200",
"floor": null,
"city": "Köln",
"plz": "50678",
"personcompany": null,
"alternativeStreet": null,
"alternativeHousenumber": null,
"alternativeCity": null,
"alternativePlz": null,
"infoIdentification": null,
"nameReadoutCard": null,
"firstNameReadoutCard": null,
"structureReadoutCard": null,
"streetReadoutCard": null,
"houseNumberReadoutCard": null,
"cityReadoutCard": null,
"plzReadoutCard": null,
"contactPerson": "Herr Müller",
"contactText": "mueller@test.de",
"contactType": "EM",
"meterManufacturer": null,
"meterInfo": null,
"meterType": null,
"mpContactTitle": null,
"mpContactFirstname": null,
"mpContactLastname": null,
"mpContactCompany": null,
"mpContactStreet": null,
"mpContactHousenumber": null,
"mpContactPlz": null,
"mpContactCity": null,
"tsnReadoutType": null,
"tsnObisCodeList": null,
"mpBuilding": null,
"mpFloor": null,
"mpRoom": null,
"mpLocDescription": null,
"meterMedium": null,
"mpContactPhone": null,
"mpContactMobile": null,
"mpContactEmail": null,
"mpContactFax": null,
"favoriteName": null
}
Geschäftsdatenanfrage
{
"group": "Level1Test",
"processName": "Geschäftsdatenanfrage",
"processPart": "NLI090010",
"processStep": null,
"processInstance": null,
"meteringNr": null,
"meteringPoint": "DE70081333332MUST0000000000000029",
"ownILN": "9910891000004",
"partnerILN": "9900496000005",
"created": null,
"terminationDate": null,
"type": null,
"reason": null,
"currentStatus": null,
"statusShortText": null,
"referenceNr": null,
"transactionNr": null,
"defectType": null,
"defectMessage": null,
"obisNumberRequest": null,
"dateFrom": null,
"dateTo": null,
"name": null,
"firstname": null,
"street": null,
"housenumber": null,
"floor": null,
"city": null,
"plz": null,
"personcompany": null,
"alternativeStreet": null,
"alternativeHousenumber": null,
"alternativeCity": null,
"alternativePlz": null,
"infoIdentification": null,
"nameReadoutCard": null,
"firstNameReadoutCard": null,
"structureReadoutCard": null,
"streetReadoutCard": null,
"houseNumberReadoutCard": null,
"cityReadoutCard": null,
"plzReadoutCard": null,
"contactPerson": null,
"contactText": null,
"contactType": null,
"meterManufacturer": null,
"meterInfo": null,
"meterType": null,
"mpContactTitle": null,
"mpContactFirstname": null,
"mpContactLastname": null,
"mpContactCompany": null,
"mpContactStreet": null,
"mpContactHousenumber": null,
"mpContactPlz": null,
"mpContactCity": null,
"tsnReadoutType": null,
"tsnObisCodeList": null,
"mpBuilding": null,
"mpFloor": null,
"mpRoom": null,
"mpLocDescription": null,
"meterMedium": null,
"mpContactPhone": null,
"mpContactMobile": null,
"mpContactEmail": null,
"mpContactFax": null,
"favoriteName": null
}
Anforderung Messwerte
{
"group": "Upload",
"processName": "AnforderungMesswerte",
"processPart": null,
"processStep": null,
"processInstance": null,
"meteringNr": "4715G",
"meteringPoint": "DE70081333332MUST0000000000000009",
"ownILN": "9910891000004",
"partnerILN": "9900496000005",
"created": null,
"terminationDate": null,
"type": null,
"reason": null,
"currentStatus": null,
"statusShortText": null,
"referenceNr": null,
"transactionNr": null,
"defectType": null,
"defectMessage": null,
"obisNumberRequest": "1-1:1.8.1",
"dateFrom": "2018-09-13T00:00:00",
"dateTo": "2018-09-14T00:00:00",
"name": null,
"firstname": null,
"street": null,
"housenumber": null,
"floor": null,
"city": null,
"plz": null,
"personcompany": null,
"alternativeStreet": null,
"alternativeHousenumber": null,
"alternativeCity": null,
"alternativePlz": null,
"infoIdentification": null,
"nameReadoutCard": null,
"firstNameReadoutCard": null,
"structureReadoutCard": null,
"streetReadoutCard": null,
"houseNumberReadoutCard": null,
"cityReadoutCard": null,
"plzReadoutCard": null,
"contactPerson": null,
"contactText": null,
"contactType": null,
"meterManufacturer": null,
"meterInfo": null,
"meterType": null,
"mpContactTitle": null,
"mpContactFirstname": null,
"mpContactLastname": null,
"mpContactCompany": null,
"mpContactStreet": null,
"mpContactHousenumber": null,
"mpContactPlz": null,
"mpContactCity": null,
"tsnReadoutType": null,
"tsnObisCodeList": null,
"mpBuilding": null,
"mpFloor": null,
"mpRoom": null,
"mpLocDescription": null,
"meterMedium": null,
"mpContactPhone": null,
"mpContactMobile": null,
"mpContactEmail": null,
"mpContactFax": null,
"favoriteName": null
}