Prozessauslöser NB
Übermittlung einer Definition des NB…
START_UEBERM_DEFINITION (NB)
POST
https://api.macoapp.de
/inbound
Startet diese Rollensichten (1):
START_UEBERM_DEFINITION (NB) › Request Body
Der Rumpf dieses Aufrufs — eine Spalte je zulässigem Prüfidentifikator. Ein Wert in der Spalte heißt, dass das Feld zu diesem Prüfidentifikator gehört: Muss, wenn das Schema es verlangt, sonst Kann.
| Struktur (BO4E) | Beschreibung | Format | 25005 | 25008 | 25009 | Bedingung |
|---|---|---|---|---|---|---|
| stammdaten* | — | object | Muss | Muss | Muss | |
| ZAEHLZEITDEFINITION[ ]* | — | object[] | Muss | |||
beginndatum*00010 | Der inklusive Zeitpunkt ab dem die Zaehlzeitdefinitionen ausgerollt sind | string (date-time) | Muss | |||
code*00020 | Code der Leistungskurve | string | Muss | |||
endedatum00030 | Der exklusive Zeitpunkt bis zu dem die Zaehlzeitdefinitionen ausgerollt sind | string (date-time) | Kann | |||
version*00040 | Version der Zählzeitdefinition als Datum | string (date-time) | Muss | |||
| zaehlzeiten[ ]* | — | object[] | Muss | |||
aenderungszeitpunkt*00050 | aenderungszeitpunkt | string (date-time) | Muss | |||
haeufigkeit00060 | Häufigkeit der Übermittlung | string | Kann | |||
EINMALIG | Kann | |||||
JAEHRLICH | Kann | |||||
register*00070 | Zählzeitregister | string | Muss | |||
| SCHALTZEITDEFINITION[ ]* | — | object[] | Muss | |||
beginndatum*00080 | Der inklusive Zeitpunkt ab dem die Zaehlzeitdefinitionen ausgerollt sind | string (date-time) | Muss | |||
code*00090 | Code der Leistungskurve | string | Muss | |||
endedatum00100 | Der exklusive Zeitpunkt bis zu dem die Zaehlzeitdefinitionen ausgerollt sind | string (date-time) | Kann | |||
version*00110 | Version der Zählzeitdefinition als Datum | string (date-time) | Muss | |||
| schaltzeiten[ ]* | — | object[] | Muss | |||
aenderungszeitpunkt*00120 | aenderungszeitpunkt | string (date-time) | Muss | |||
haeufigkeit00130 | Häufigkeit der Übermittlung | string | Kann | |||
EINMALIG | Kann | |||||
JAEHRLICH | Kann | |||||
schalthandlung*00140 | Schalthandlung | string | Muss | |||
LEISTUNG_AN | Muss | |||||
LEISTUNG_AUS | Muss | |||||
| LEISTUNGSKURVENDEFINITION[ ]* | — | object[] | Muss | |||
beginndatum*00150 | Der inklusive Zeitpunkt ab dem die Zaehlzeitdefinitionen ausgerollt sind | string (date-time) | Muss | |||
code*00160 | Code der Leistungskurve | string | Muss | |||
endedatum00170 | Der exklusive Zeitpunkt bis zu dem die Zaehlzeitdefinitionen ausgerollt sind | string (date-time) | Kann | |||
version*00180 | Version der Zählzeitdefinition als Datum | string (date-time) | Muss | |||
| leistungskurven[ ]* | — | object[] | Muss | |||
aenderungszeitpunkt*00190 | aenderungszeitpunkt | string (date-time) | Muss | |||
haeufigkeit00200 | Häufigkeit der Übermittlung | string | Kann | |||
EINMALIG | Kann | |||||
JAEHRLICH | Kann | |||||
| schwellwert* | — | object | Muss | |||
obererSchwellwert*00210 | obererSchwellwert | number (float) | Muss | |||
| transaktionsdaten* | — | object | Muss | Muss | Muss | |
anfrageReferenz*00220 | Beantragungsnummer / RFF+AGI | string | Muss | Muss | Muss | |
kategorie*00230 | Qualifier aus dem Beginn der EDIFact Nachricht / BGM | string | Muss | Muss | Muss | |
pruefidentifikator00240 | Wird dynamisch im Event-Prozess ermittelt (Entscheidungsgrundlage: kategorie). Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 25005, 25008, 25009. | — | Kann | Kann | Kann | |
sparte*00250 | Enthält Informationen über die Sparte | string | Muss | Muss | Muss | |
STROM | Muss | Muss | Muss | |||
GAS | Muss | Muss | Muss | |||
FERNWAERME | Muss | Muss | Muss | |||
NAHWAERME | Muss | Muss | Muss | |||
WASSER | Muss | Muss | Muss | |||
ABWASSER | Muss | Muss | Muss | |||
| absender* | — | object | Muss | Muss | Muss | |
rollencodenummer00260 | Gibt die Codenummer der Marktrolle an. | string | Kann | Kann | Kann | |
| empfaenger* | — | object | Muss | Muss | Muss | |
rollencodenummer00270 | Gibt die Codenummer der Marktrolle an. | string | Kann | Kann | Kann | |
| zusatzdaten* | — | object | Muss | Muss | Muss | |
eventname*00280 | — | string | Muss | Muss | Muss | |
prozessId*00290 | — | string | Muss | Muss | Muss |
START_UEBERM_DEFINITION (NB) › Responses
Erfolg | Success
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
businessKey* | Einzigartige Kennung des Geschäftsprozesses | Unique identifier of the business process | string (uuid) |
message* | Nachricht mit Details zum ausgelösten Event | Message with details about the triggered event | string |
Trigger-Event START_UEBERM_DEFINITION der Marktrolle NB.
Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).
Hinweise zu dieser Seite
Der Aufruf geht tatsächlich an POST /inbound; das Event ergibt sich aus zusatzdaten.eventname im Rumpf. Diese Seite trennt eine von 105 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.