Gerätewechsel

START_GERAETEWECHSEL (MSB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (2):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "ANFRAGE": [
      {
        "anfragetyp": "KAUF",
        "lokationsId": "lokationsId"
      }
    ],
    "AUFTRAG": [
      {
        "ausfuehrungsdatum": "2024-08-25T15:00:00Z"
      }
    ],
    "ZAEHLER": [
      {
        "geraete": [
          {
            "geraeteeigenschaften": {
              "geraetetyp": "WECHSELSTROMZAEHLER"
            },
            "geraetenummer": "geraetenummer",
            "weitereGeraetenummern": [
              "string"
            ]
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "17009",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_GERAETEWECHSEL",
    "prozessId": "prozessId"
  }
}'

START_GERAETEWECHSEL (MSB) › 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	17009
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
`lokationsId`*00020	Für welche Markt- oder Messlokation gilt diese Anfrage.	string	Muss
AUFTRAG[ ]*	—	object[]	Muss
`ausfuehrungsdatum`*00030	Das Ausführungsdatum beschreibt zu welchem Zeitpunkt ein Auftrag ausgeführt werden soll.	string (date-time)	Muss
ZAEHLER[ ]*	—	object[]	Muss
geraete[ ]*	—	object[]	Muss
`geraetenummer`*00040	Die auf dem Geräte aufgedruckte Nummer, die vom MSB vergeben wird.	string	Muss
`weitereGeraetenummern`[ ]00050	weitereGeraetenummern	string[]	Kann
geraeteeigenschaften*	—	object	Muss
`geraetetyp`*00060	Auflistung möglicher abzurechnender Gerätetypen	string	Muss
`WECHSELSTROMZAEHLER`			Muss
`DREHSTROMZAEHLER`			Muss
`ZWEIRICHTUNGSZAEHLER`			Muss
`RLM_ZAEHLER`			Muss
`IMS_ZAEHLER`			Muss
`BALGENGASZAEHLER`			Muss
`MAXIMUMZAEHLER`			Muss
`MULTIPLEXANLAGE`			Muss
`PAUSCHALANLAGE`			Muss
`VERSTAERKERANLAGE`			Muss
`SUMMATIONSGERAET`			Muss
`IMPULSGEBER`			Muss
`EDL_21_ZAEHLERAUFSATZ`			Muss
`VIER_QUADRANTEN_LASTGANGZAEHLER`			Muss
`MENGENUMWERTER`			Muss
`STROMWANDLER`			Muss
`SPANNUNGSWANDLER`			Muss
`DATENLOGGER`			Muss
`KOMMUNIKATIONSANSCHLUSS`			Muss
`MODEM`			Muss
`TELEKOMMUNIKATIONSEINRICHTUNG`			Muss
`KOMMUNIKATIONSEINRICHTUNG`			Muss
`DREHKOLBENGASZAEHLER`			Muss
`TURBINENRADGASZAEHLER`			Muss
`ULTRASCHALLZAEHLER`			Muss
`WIRBELGASZAEHLER`			Muss
`MODERNE_MESSEINRICHTUNG`			Muss
`ELEKTRONISCHER_HAUSHALTSZAEHLER`			Muss
`STEUEREINRICHTUNG`			Muss
`TECHNISCHESTEUEREINRICHTUNG`			Muss
`TARIFSCHALTGERAET`			Muss
`RUNDSTEUEREMPFAENGER`			Muss
`OPTIONALE_ZUS_ZAEHLEINRICHTUNG`			Muss
`MESSWANDLERSATZ_IMS_MME`			Muss
`KOMBIMESSWANDLER_IMS_MME`			Muss
`TARIFSCHALTGERAET_IMS_MME`			Muss
`RUNDSTEUEREMPFAENGER_IMS_MME`			Muss
`TEMPERATUR_KOMPENSATION`			Muss
`HOECHSTBELASTUNGS_ANZEIGER`			Muss
`SONSTIGES_GERAET`			Muss
`SMARTMETERGATEWAY`			Muss
`STEUERBOX`			Muss
`BLOCKSTROMWANDLER`			Muss
`KOMBIMESSWANDLER`			Muss
`MODEM_GSM`			Muss
`ETHERNET_KOM`			Muss
`PLC_COM`			Muss
`MODEM_FESTNETZ`			Muss
`DSL_KOM`			Muss
`LTE_KOM`			Muss
`DICHTEMENGENUMWERTER`			Muss
`TEMPERATURMENGENUMWERTER`			Muss
`ZUSTANDSMENGENUMWERTER`			Muss
`MESSDATENREGISTRIERGERAET`			Muss
`WANDLER`			Muss
`BEFESTIGUNGSEINRICHTUNG`			Muss
transaktionsdaten*	—	object	Muss
`kategorie`*00070	Qualifier aus dem Beginn der EDIFact Nachricht / BGM	string	Muss
`pruefidentifikator`00080	Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 17009.	—	Kann
`sparte`*00090	Enthält Informationen über die Sparte	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`marktrolle`00100	Gibt im Klartext die Bezeichnung der Marktrolle an.	string	Kann
`NB`			Kann
`LF`			Kann
`MSB`			Kann
`MSBA`			Kann
`GMSB`			Kann
`MDL`			Kann
`DL`			Kann
`BKV`			Kann
`BKO`			Kann
`UENB`			Kann
`KUNDE-SELBST-NN`			Kann
`MGV`			Kann
`EIV`			Kann
`RB`			Kann
`KUNDE`			Kann
`INTERESSENT`			Kann
`KN`			Kann
`UBA`			Kann
`BIKO`			Kann
`ESA`			Kann
`rollencodenummer`00110	Gibt die Codenummer der Marktrolle an.	string	Kann
empfaenger*	—	object	Muss
`marktrolle`00120	Gibt im Klartext die Bezeichnung der Marktrolle an.	string	Kann
`NB`			Kann
`LF`			Kann
`MSB`			Kann
`MSBA`			Kann
`GMSB`			Kann
`MDL`			Kann
`DL`			Kann
`BKV`			Kann
`BKO`			Kann
`UENB`			Kann
`KUNDE-SELBST-NN`			Kann
`MGV`			Kann
`EIV`			Kann
`RB`			Kann
`KUNDE`			Kann
`INTERESSENT`			Kann
`KN`			Kann
`UBA`			Kann
`BIKO`			Kann
`ESA`			Kann
`rollencodenummer`00130	Gibt die Codenummer der Marktrolle an.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00140	—	string	Muss
`prozessId`*00150	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "ANFRAGE": [
      {
        "anfragetyp": "KAUF",
        "lokationsId": "lokationsId"
      }
    ],
    "AUFTRAG": [
      {
        "ausfuehrungsdatum": "2024-08-25T15:00:00Z"
      }
    ],
    "ZAEHLER": [
      {
        "geraete": [
          {
            "geraeteeigenschaften": {
              "geraetetyp": "WECHSELSTROMZAEHLER"
            },
            "geraetenummer": "geraetenummer",
            "weitereGeraetenummern": [
              "string"
            ]
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "17009",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_GERAETEWECHSEL",
    "prozessId": "prozessId"
  }
}

json

START_GERAETEWECHSEL (MSB) › 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_GERAETEWECHSEL der Marktrolle MSB.

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.

Geräteübernahme Geschäftsdatenanfrage vom MSB an NB

START_GERAETEWECHSEL (MSB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (2):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "ANFRAGE": [
      {
        "anfragetyp": "KAUF",
        "lokationsId": "lokationsId"
      }
    ],
    "AUFTRAG": [
      {
        "ausfuehrungsdatum": "2024-08-25T15:00:00Z"
      }
    ],
    "ZAEHLER": [
      {
        "geraete": [
          {
            "geraeteeigenschaften": {
              "geraetetyp": "WECHSELSTROMZAEHLER"
            },
            "geraetenummer": "geraetenummer",
            "weitereGeraetenummern": [
              "string"
            ]
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "17009",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_GERAETEWECHSEL",
    "prozessId": "prozessId"
  }
}'

START_GERAETEWECHSEL (MSB) › Request Body

Struktur (BO4E)	Beschreibung	Format	17009
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
`lokationsId`*00020	Für welche Markt- oder Messlokation gilt diese Anfrage.	string	Muss
AUFTRAG[ ]*	—	object[]	Muss
`ausfuehrungsdatum`*00030	Das Ausführungsdatum beschreibt zu welchem Zeitpunkt ein Auftrag ausgeführt werden soll.	string (date-time)	Muss
ZAEHLER[ ]*	—	object[]	Muss
geraete[ ]*	—	object[]	Muss
`geraetenummer`*00040	Die auf dem Geräte aufgedruckte Nummer, die vom MSB vergeben wird.	string	Muss
`weitereGeraetenummern`[ ]00050	weitereGeraetenummern	string[]	Kann
geraeteeigenschaften*	—	object	Muss
`geraetetyp`*00060	Auflistung möglicher abzurechnender Gerätetypen	string	Muss
`WECHSELSTROMZAEHLER`			Muss
`DREHSTROMZAEHLER`			Muss
`ZWEIRICHTUNGSZAEHLER`			Muss
`RLM_ZAEHLER`			Muss
`IMS_ZAEHLER`			Muss
`BALGENGASZAEHLER`			Muss
`MAXIMUMZAEHLER`			Muss
`MULTIPLEXANLAGE`			Muss
`PAUSCHALANLAGE`			Muss
`VERSTAERKERANLAGE`			Muss
`SUMMATIONSGERAET`			Muss
`IMPULSGEBER`			Muss
`EDL_21_ZAEHLERAUFSATZ`			Muss
`VIER_QUADRANTEN_LASTGANGZAEHLER`			Muss
`MENGENUMWERTER`			Muss
`STROMWANDLER`			Muss
`SPANNUNGSWANDLER`			Muss
`DATENLOGGER`			Muss
`KOMMUNIKATIONSANSCHLUSS`			Muss
`MODEM`			Muss
`TELEKOMMUNIKATIONSEINRICHTUNG`			Muss
`KOMMUNIKATIONSEINRICHTUNG`			Muss
`DREHKOLBENGASZAEHLER`			Muss
`TURBINENRADGASZAEHLER`			Muss
`ULTRASCHALLZAEHLER`			Muss
`WIRBELGASZAEHLER`			Muss
`MODERNE_MESSEINRICHTUNG`			Muss
`ELEKTRONISCHER_HAUSHALTSZAEHLER`			Muss
`STEUEREINRICHTUNG`			Muss
`TECHNISCHESTEUEREINRICHTUNG`			Muss
`TARIFSCHALTGERAET`			Muss
`RUNDSTEUEREMPFAENGER`			Muss
`OPTIONALE_ZUS_ZAEHLEINRICHTUNG`			Muss
`MESSWANDLERSATZ_IMS_MME`			Muss
`KOMBIMESSWANDLER_IMS_MME`			Muss
`TARIFSCHALTGERAET_IMS_MME`			Muss
`RUNDSTEUEREMPFAENGER_IMS_MME`			Muss
`TEMPERATUR_KOMPENSATION`			Muss
`HOECHSTBELASTUNGS_ANZEIGER`			Muss
`SONSTIGES_GERAET`			Muss
`SMARTMETERGATEWAY`			Muss
`STEUERBOX`			Muss
`BLOCKSTROMWANDLER`			Muss
`KOMBIMESSWANDLER`			Muss
`MODEM_GSM`			Muss
`ETHERNET_KOM`			Muss
`PLC_COM`			Muss
`MODEM_FESTNETZ`			Muss
`DSL_KOM`			Muss
`LTE_KOM`			Muss
`DICHTEMENGENUMWERTER`			Muss
`TEMPERATURMENGENUMWERTER`			Muss
`ZUSTANDSMENGENUMWERTER`			Muss
`MESSDATENREGISTRIERGERAET`			Muss
`WANDLER`			Muss
`BEFESTIGUNGSEINRICHTUNG`			Muss
transaktionsdaten*	—	object	Muss
`kategorie`*00070	Qualifier aus dem Beginn der EDIFact Nachricht / BGM	string	Muss
`pruefidentifikator`00080	Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 17009.	—	Kann
`sparte`*00090	Enthält Informationen über die Sparte	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`marktrolle`00100	Gibt im Klartext die Bezeichnung der Marktrolle an.	string	Kann
`NB`			Kann
`LF`			Kann
`MSB`			Kann
`MSBA`			Kann
`GMSB`			Kann
`MDL`			Kann
`DL`			Kann
`BKV`			Kann
`BKO`			Kann
`UENB`			Kann
`KUNDE-SELBST-NN`			Kann
`MGV`			Kann
`EIV`			Kann
`RB`			Kann
`KUNDE`			Kann
`INTERESSENT`			Kann
`KN`			Kann
`UBA`			Kann
`BIKO`			Kann
`ESA`			Kann
`rollencodenummer`00110	Gibt die Codenummer der Marktrolle an.	string	Kann
empfaenger*	—	object	Muss
`marktrolle`00120	Gibt im Klartext die Bezeichnung der Marktrolle an.	string	Kann
`NB`			Kann
`LF`			Kann
`MSB`			Kann
`MSBA`			Kann
`GMSB`			Kann
`MDL`			Kann
`DL`			Kann
`BKV`			Kann
`BKO`			Kann
`UENB`			Kann
`KUNDE-SELBST-NN`			Kann
`MGV`			Kann
`EIV`			Kann
`RB`			Kann
`KUNDE`			Kann
`INTERESSENT`			Kann
`KN`			Kann
`UBA`			Kann
`BIKO`			Kann
`ESA`			Kann
`rollencodenummer`00130	Gibt die Codenummer der Marktrolle an.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00140	—	string	Muss
`prozessId`*00150	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "ANFRAGE": [
      {
        "anfragetyp": "KAUF",
        "lokationsId": "lokationsId"
      }
    ],
    "AUFTRAG": [
      {
        "ausfuehrungsdatum": "2024-08-25T15:00:00Z"
      }
    ],
    "ZAEHLER": [
      {
        "geraete": [
          {
            "geraeteeigenschaften": {
              "geraetetyp": "WECHSELSTROMZAEHLER"
            },
            "geraetenummer": "geraetenummer",
            "weitereGeraetenummern": [
              "string"
            ]
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "17009",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_GERAETEWECHSEL",
    "prozessId": "prozessId"
  }
}

json

START_GERAETEWECHSEL (MSB) › 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_GERAETEWECHSEL der Marktrolle MSB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Hinweise zu dieser Seite

Feedback zur Dokumentation

Feedback zur Dokumentation

Gerätewechsel

START_GERAETEWECHSEL (MSB)

START_GERAETEWECHSEL (MSB) › Request Body

START_GERAETEWECHSEL (MSB) › Responses

Gerätewechsel

START_GERAETEWECHSEL (MSB)

START_GERAETEWECHSEL (MSB) › Request Body

START_GERAETEWECHSEL (MSB) › Responses