Reklamation vom NB

START_REKLAMATION_WERTE (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (1):

Reklamation vom NB — NB

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "ANFRAGE": [
      {
        "anfragetyp": "KAUF",
        "gueltigAb": "2024-08-25T15:00:00Z"
      }
    ],
    "AUFTRAG": [
      {
        "positionsdaten": [
          {
            "positionsnummer": 0
          }
        ]
      }
    ],
    "REKLAMATION": [
      {
        "konfiguration": "konfiguration",
        "lokationsId": "lokationsId",
        "obiskennzahl": "obiskennzahl",
        "reklamationsgrund": "WERTE_ZU_HOCH",
        "reklamationsgrundBemerkung": {
          "bemerkung1": "bemerkung1",
          "bemerkung2": "bemerkung2",
          "bemerkung3": "bemerkung3",
          "bemerkung4": "bemerkung4",
          "bemerkung5": "bemerkung5"
        },
        "zeitraumMesswertanfrage": {
          "enddatum": "2024-08-25T15:00:00Z",
          "startdatum": "2024-08-25T15:00:00Z"
        }
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "angebotsreferenz": "angebotsreferenz",
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "pruefidentifikator": "17113",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_REKLAMATION_WERTE",
    "prozessId": "prozessId"
  }
}'

START_REKLAMATION_WERTE (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	17113
stammdaten*	—	object	Muss
ANFRAGE[ ]*	—	object[]	Muss
`anfragetyp`*00010	Typ/Art der Anfrage (ORDERS ORDRSP IMD 7081)	string	Muss
`KAUF`			Muss
`NUTZUNGSUEBERLASSUNG`			Muss
`ABRECHNUNGSBRENNWERT_UND_ZUSTANDSZAHL`			Muss
`LASTGANGDATEN`			Muss
`ZAEHLERSTAENDE`			Muss
`WERTEERMITTLUNG`			Muss
`ENERGIEMENGE_EINZELWERT`			Muss
`INNERHALB_DER_ARBEITSZEIT`			Muss
`AUCH_AUSSERHALB_DER_ARBEITSZEIT`			Muss
`WECHSEL_SAEMTLICHER_EINRICHTUNGEN`			Muss
`TEILWEISER_WECHSEL`			Muss
`AENDERUNG_ZAEHLZEITDEFINITION`			Muss
`ABBESTELLUNG_ZAEHLZEITEN`			Muss
`ABBESTELLUNG_MESSPRODUKT`			Muss
`ANGEBOT_AUF_BASIS_PREISBLATT`			Muss
`INDIVIDUELLES_ANGEBOT`			Muss
`AENDERUNG_KONFIGURATION`			Muss
`KANN_NICHT_ANGEBOTEN_WERDEN`			Muss
`NEUKONFIGURATION`			Muss
`BEENDIGUNG_KONFIGURATION`			Muss
`AKTIVIERUNG_KONFIGURATION`			Muss
`gueltigAb`00020	gueltigAb	string (date-time)	Kann
AUFTRAG[ ]*	—	object[]	Muss
positionsdaten[ ]*	—	object[]	Muss
`positionsnummer`*00030	Positionsnummer	integer	Muss
REKLAMATION[ ]*	—	object[]	Muss
`konfiguration`00040	Konfiguration (iMSys) des Zählwerks	string	Kann
`lokationsId`00050	Für welche Markt- oder Messlokation gilt diese Anfrage.	string	Kann
`obiskennzahl`*00060	obiskennzahl	string	Muss
`reklamationsgrund`*00070	Hier wird für die Reklamation von Werten der Reklamationsgrund angegeben.	string	Muss
`WERTE_ZU_HOCH`			Muss
`WERTE_ZU_NIEDRIG`			Muss
`WERTE_FEHLEN`			Muss
`KONFIGURATION_WIRKT_NICHT`			Muss
`KONFIGURATION_WIRKT_TEILWEISE`			Muss
`WERTE_WERDEN_NICHT_NACH_VORGABEN_UEBERMITTELT`			Muss
`UEBERSICHT_FEHLT`			Muss
`UEBERSICHT_UNPLAUSIBEL`			Muss
`AUSGEROLLTE_DEFINITION_FEHLT`			Muss
`AUSGEROLLTE_DEFINITION_UNPLAUSIBEL`			Muss
reklamationsgrundBemerkung	—	object	Kann
`bemerkung1`00080	bemerkung1	string	Kann
`bemerkung2`00090	bemerkung2	string	Kann
`bemerkung3`00100	bemerkung3	string	Kann
`bemerkung4`00110	bemerkung4	string	Kann
`bemerkung5`00120	bemerkung5	string	Kann
zeitraumMesswertanfrage	—	object	Kann
`enddatum`00130	enddatum	string (date-time)	Kann
`startdatum`00140	startdatum	string (date-time)	Kann
transaktionsdaten*	—	object	Muss
`angebotsreferenz`*00150	Referenznummer einer vorangegangenen Nachricht / ORDERS RFF+ACW	string	Muss
`pruefidentifikator`00160	Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 17113.	—	Kann
`sparte`*00170	Enthält Informationen über die Sparte	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`rollencodenummer`00180	Gibt die Codenummer der Marktrolle an.	string	Kann
empfaenger*	—	object	Muss
`rollencodenummer`00190	Gibt die Codenummer der Marktrolle an.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00200	—	string	Muss
`prozessId`*00210	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "ANFRAGE": [
      {
        "anfragetyp": "KAUF",
        "gueltigAb": "2024-08-25T15:00:00Z"
      }
    ],
    "AUFTRAG": [
      {
        "positionsdaten": [
          {
            "positionsnummer": 0
          }
        ]
      }
    ],
    "REKLAMATION": [
      {
        "konfiguration": "konfiguration",
        "lokationsId": "lokationsId",
        "obiskennzahl": "obiskennzahl",
        "reklamationsgrund": "WERTE_ZU_HOCH",
        "reklamationsgrundBemerkung": {
          "bemerkung1": "bemerkung1",
          "bemerkung2": "bemerkung2",
          "bemerkung3": "bemerkung3",
          "bemerkung4": "bemerkung4",
          "bemerkung5": "bemerkung5"
        },
        "zeitraumMesswertanfrage": {
          "enddatum": "2024-08-25T15:00:00Z",
          "startdatum": "2024-08-25T15:00:00Z"
        }
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "angebotsreferenz": "angebotsreferenz",
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "pruefidentifikator": "17113",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_REKLAMATION_WERTE",
    "prozessId": "prozessId"
  }
}

json

START_REKLAMATION_WERTE (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_REKLAMATION_WERTE 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.

Reklamation der Übersicht der…Übermittlung einer Definition des NB…

Prozessauslöser NB

Reklamation vom NB

Download schema

START_REKLAMATION_WERTE (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (1):

Reklamation vom NB — NB

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "ANFRAGE": [
      {
        "anfragetyp": "KAUF",
        "gueltigAb": "2024-08-25T15:00:00Z"
      }
    ],
    "AUFTRAG": [
      {
        "positionsdaten": [
          {
            "positionsnummer": 0
          }
        ]
      }
    ],
    "REKLAMATION": [
      {
        "konfiguration": "konfiguration",
        "lokationsId": "lokationsId",
        "obiskennzahl": "obiskennzahl",
        "reklamationsgrund": "WERTE_ZU_HOCH",
        "reklamationsgrundBemerkung": {
          "bemerkung1": "bemerkung1",
          "bemerkung2": "bemerkung2",
          "bemerkung3": "bemerkung3",
          "bemerkung4": "bemerkung4",
          "bemerkung5": "bemerkung5"
        },
        "zeitraumMesswertanfrage": {
          "enddatum": "2024-08-25T15:00:00Z",
          "startdatum": "2024-08-25T15:00:00Z"
        }
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "angebotsreferenz": "angebotsreferenz",
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "pruefidentifikator": "17113",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_REKLAMATION_WERTE",
    "prozessId": "prozessId"
  }
}'

START_REKLAMATION_WERTE (NB) › Request Body

Struktur (BO4E)	Beschreibung	Format	17113
stammdaten*	—	object	Muss
ANFRAGE[ ]*	—	object[]	Muss
`anfragetyp`*00010	Typ/Art der Anfrage (ORDERS ORDRSP IMD 7081)	string	Muss
`KAUF`			Muss
`NUTZUNGSUEBERLASSUNG`			Muss
`ABRECHNUNGSBRENNWERT_UND_ZUSTANDSZAHL`			Muss
`LASTGANGDATEN`			Muss
`ZAEHLERSTAENDE`			Muss
`WERTEERMITTLUNG`			Muss
`ENERGIEMENGE_EINZELWERT`			Muss
`INNERHALB_DER_ARBEITSZEIT`			Muss
`AUCH_AUSSERHALB_DER_ARBEITSZEIT`			Muss
`WECHSEL_SAEMTLICHER_EINRICHTUNGEN`			Muss
`TEILWEISER_WECHSEL`			Muss
`AENDERUNG_ZAEHLZEITDEFINITION`			Muss
`ABBESTELLUNG_ZAEHLZEITEN`			Muss
`ABBESTELLUNG_MESSPRODUKT`			Muss
`ANGEBOT_AUF_BASIS_PREISBLATT`			Muss
`INDIVIDUELLES_ANGEBOT`			Muss
`AENDERUNG_KONFIGURATION`			Muss
`KANN_NICHT_ANGEBOTEN_WERDEN`			Muss
`NEUKONFIGURATION`			Muss
`BEENDIGUNG_KONFIGURATION`			Muss
`AKTIVIERUNG_KONFIGURATION`			Muss
`gueltigAb`00020	gueltigAb	string (date-time)	Kann
AUFTRAG[ ]*	—	object[]	Muss
positionsdaten[ ]*	—	object[]	Muss
`positionsnummer`*00030	Positionsnummer	integer	Muss
REKLAMATION[ ]*	—	object[]	Muss
`konfiguration`00040	Konfiguration (iMSys) des Zählwerks	string	Kann
`lokationsId`00050	Für welche Markt- oder Messlokation gilt diese Anfrage.	string	Kann
`obiskennzahl`*00060	obiskennzahl	string	Muss
`reklamationsgrund`*00070	Hier wird für die Reklamation von Werten der Reklamationsgrund angegeben.	string	Muss
`WERTE_ZU_HOCH`			Muss
`WERTE_ZU_NIEDRIG`			Muss
`WERTE_FEHLEN`			Muss
`KONFIGURATION_WIRKT_NICHT`			Muss
`KONFIGURATION_WIRKT_TEILWEISE`			Muss
`WERTE_WERDEN_NICHT_NACH_VORGABEN_UEBERMITTELT`			Muss
`UEBERSICHT_FEHLT`			Muss
`UEBERSICHT_UNPLAUSIBEL`			Muss
`AUSGEROLLTE_DEFINITION_FEHLT`			Muss
`AUSGEROLLTE_DEFINITION_UNPLAUSIBEL`			Muss
reklamationsgrundBemerkung	—	object	Kann
`bemerkung1`00080	bemerkung1	string	Kann
`bemerkung2`00090	bemerkung2	string	Kann
`bemerkung3`00100	bemerkung3	string	Kann
`bemerkung4`00110	bemerkung4	string	Kann
`bemerkung5`00120	bemerkung5	string	Kann
zeitraumMesswertanfrage	—	object	Kann
`enddatum`00130	enddatum	string (date-time)	Kann
`startdatum`00140	startdatum	string (date-time)	Kann
transaktionsdaten*	—	object	Muss
`angebotsreferenz`*00150	Referenznummer einer vorangegangenen Nachricht / ORDERS RFF+ACW	string	Muss
`pruefidentifikator`00160	Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 17113.	—	Kann
`sparte`*00170	Enthält Informationen über die Sparte	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`rollencodenummer`00180	Gibt die Codenummer der Marktrolle an.	string	Kann
empfaenger*	—	object	Muss
`rollencodenummer`00190	Gibt die Codenummer der Marktrolle an.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00200	—	string	Muss
`prozessId`*00210	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "ANFRAGE": [
      {
        "anfragetyp": "KAUF",
        "gueltigAb": "2024-08-25T15:00:00Z"
      }
    ],
    "AUFTRAG": [
      {
        "positionsdaten": [
          {
            "positionsnummer": 0
          }
        ]
      }
    ],
    "REKLAMATION": [
      {
        "konfiguration": "konfiguration",
        "lokationsId": "lokationsId",
        "obiskennzahl": "obiskennzahl",
        "reklamationsgrund": "WERTE_ZU_HOCH",
        "reklamationsgrundBemerkung": {
          "bemerkung1": "bemerkung1",
          "bemerkung2": "bemerkung2",
          "bemerkung3": "bemerkung3",
          "bemerkung4": "bemerkung4",
          "bemerkung5": "bemerkung5"
        },
        "zeitraumMesswertanfrage": {
          "enddatum": "2024-08-25T15:00:00Z",
          "startdatum": "2024-08-25T15:00:00Z"
        }
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "angebotsreferenz": "angebotsreferenz",
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "pruefidentifikator": "17113",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_REKLAMATION_WERTE",
    "prozessId": "prozessId"
  }
}

json

START_REKLAMATION_WERTE (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_REKLAMATION_WERTE der Marktrolle NB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Hinweise zu dieser Seite

Reklamation der Übersicht der…Übermittlung einer Definition des NB…

Feedback zur Dokumentation

Feedback zur Dokumentation

Reklamation vom NB

START_REKLAMATION_WERTE (NB)

START_REKLAMATION_WERTE (NB) › Request Body

START_REKLAMATION_WERTE (NB) › Responses

Reklamation vom NB

START_REKLAMATION_WERTE (NB)

START_REKLAMATION_WERTE (NB) › Request Body

START_REKLAMATION_WERTE (NB) › Responses