Device replacement

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

The body of this call — one column per admissible Prüfidentifikator. A value in the column means the field belongs to that Prüfidentifikator: Must where the schema requires it, otherwise May.

Structure (BO4E)	Description	Format	17009
stammdaten*	—	object	Muss
ANFRAGE[ ]*	—	object[]	Muss
`anfragetyp`*00010	Type/kind of the request (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	Which market or metering location this request applies to.	string	Muss
AUFTRAG[ ]*	—	object[]	Muss
`ausfuehrungsdatum`*00030	The execution date describes at which point in time an order is to be executed.	string (date-time)	Muss
ZAEHLER[ ]*	—	object[]	Muss
geraete[ ]*	—	object[]	Muss
`geraetenummer`*00040	The number printed on the device, which is assigned by the MSB.	string	Muss
`weitereGeraetenummern`[ ]00050	weitereGeraetenummern	string[]	Kann
geraeteeigenschaften*	—	object	Muss
`geraetetyp`*00060	List of possible billable device types	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 from the beginning of the EDIFACT message / BGM	string	Muss
`pruefidentifikator`00080	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 17009.	—	Kann
`sparte`*00090	Contains information about the division	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`marktrolle`00100	Indicates the designation of the market role in free text.	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	Specifies the code value of the market role.	string	Kann
empfaenger*	—	object	Muss
`marktrolle`00120	Indicates the designation of the market role in free text.	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	Specifies the code value of the market role.	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

Success | Success

Structure (BO4E)	Description	Format
`businessKey`*	Unique identifier of the business process \| Unique identifier of the business process	string (uuid)
`message`*	Message with details about the triggered event \| Message with details about the triggered event	string

Trigger-Event START_GERAETEWECHSEL der Marktrolle MSB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

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.

Device takeover Business data request from MSB to 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

Structure (BO4E)	Description	Format	17009
stammdaten*	—	object	Muss
ANFRAGE[ ]*	—	object[]	Muss
`anfragetyp`*00010	Type/kind of the request (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	Which market or metering location this request applies to.	string	Muss
AUFTRAG[ ]*	—	object[]	Muss
`ausfuehrungsdatum`*00030	The execution date describes at which point in time an order is to be executed.	string (date-time)	Muss
ZAEHLER[ ]*	—	object[]	Muss
geraete[ ]*	—	object[]	Muss
`geraetenummer`*00040	The number printed on the device, which is assigned by the MSB.	string	Muss
`weitereGeraetenummern`[ ]00050	weitereGeraetenummern	string[]	Kann
geraeteeigenschaften*	—	object	Muss
`geraetetyp`*00060	List of possible billable device types	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 from the beginning of the EDIFACT message / BGM	string	Muss
`pruefidentifikator`00080	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 17009.	—	Kann
`sparte`*00090	Contains information about the division	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`marktrolle`00100	Indicates the designation of the market role in free text.	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	Specifies the code value of the market role.	string	Kann
empfaenger*	—	object	Muss
`marktrolle`00120	Indicates the designation of the market role in free text.	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	Specifies the code value of the market role.	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

Success | Success

Structure (BO4E)	Description	Format
`businessKey`*	Unique identifier of the business process \| Unique identifier of the business process	string (uuid)
`message`*	Message with details about the triggered event \| Message with details about the triggered event	string

Trigger-Event START_GERAETEWECHSEL der Marktrolle MSB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

Feedback on the documentation

Feedback on the documentation

Device replacement

START_GERAETEWECHSEL (MSB)

START_GERAETEWECHSEL (MSB) › Request Body

START_GERAETEWECHSEL (MSB) › Responses

Device replacement

START_GERAETEWECHSEL (MSB)

START_GERAETEWECHSEL (MSB) › Request Body

START_GERAETEWECHSEL (MSB) › Responses