[MSB] START_ANTWORT_GERAETEWECHSEL
Marktrolle MSB · Formatversion 202604 · BO4E-Schema 1.7.8
Check identifiers not yet covered
The following check identifiers are intended for this topic in business terms, but are not yet available as a specification in the current format version: 19016.
The information comes from the generator pipeline and is deliberately made visible here instead of being withheld.
Master data
Exactly one of the following 1 check identifiers is permitted under this topic — which one is decided by the event process.
| Prüfi | Scope | Use case | Regulatory determination | Communication |
|---|---|---|---|---|
| PI_19015 | ORDRSP | Confirmation of device replacement intent | WiM gas | MSBA → MSBN |
The master data of the 1 check identifier in one structure — one column per check identifier, as in the application handbook. A value in the column means that the field belongs to this check identifier: Must where its specification requires it, otherwise May. An empty cell means »not part of it«, not »unknown«. The first one is preselected; the bar above the table adds the others.
| Structure (BO4E) | Description | Format | 19015 | Condition |
|---|---|---|---|---|
| stammdaten | — | object | May | — |
| AUFTRAG [ ] | — | object[] | May | — |
| lieferadresseAltgeraete | — | object | May | — |
| anrede00010 | The form of address for the GePa, e.g. Mr. | string | May | — |
| gewerbekennzeichnung00020 | Indicates whether this is a business/company (gewerbeKennzeichnung = true) or a private individual. (gewerbeKennzeichnung = false) | boolean | May | — |
| name100030 | First part of the name. This can hold the company name or, for private individuals, the surname, for example. Examples: Yellow Strom GmbH or Hagen | string | May | — |
| name200040 | Second part of the name. Here an extension to the company name or for private individuals, for example, the first name can be entered. Examples: Bereich Süd or Nina | string | May | — |
| name300050 | Third part of the name. Further additions to the company name or , for private individuals, additions to the name can be represented here. Examples: and Africa or singer | string | May | — |
| name400060 | name4 | string | May | — |
| partneradresse | — | object | May | — |
| hausnummer00070 | House number and supplement | string | May | — |
| landescode00080 | Country code | Enum Landescode | May | — |
AC | — | — | May | — |
AD | — | — | May | — |
AE | — | — | May | — |
AF | — | — | May | — |
AG | — | — | May | — |
AI | — | — | May | — |
AL | — | — | May | — |
AM | — | — | May | — |
AN | — | — | May | — |
AO | — | — | May | — |
AQ | — | — | May | — |
AR | — | — | May | — |
AS | — | — | May | — |
AT | — | — | May | — |
AU | — | — | May | — |
AW | — | — | May | — |
AX | — | — | May | — |
AZ | — | — | May | — |
BA | — | — | May | — |
BB | — | — | May | — |
BD | — | — | May | — |
BE | — | — | May | — |
BF | — | — | May | — |
BG | — | — | May | — |
BH | — | — | May | — |
BI | — | — | May | — |
BJ | — | — | May | — |
BL | — | — | May | — |
BM | — | — | May | — |
BN | — | — | May | — |
BO | — | — | May | — |
BQ | — | — | May | — |
BR | — | — | May | — |
BS | — | — | May | — |
BT | — | — | May | — |
BU | — | — | May | — |
BV | — | — | May | — |
BW | — | — | May | — |
BY | — | — | May | — |
BZ | — | — | May | — |
CA | — | — | May | — |
CC | — | — | May | — |
CD | — | — | May | — |
CF | — | — | May | — |
CG | — | — | May | — |
CH | — | — | May | — |
CI | — | — | May | — |
CK | — | — | May | — |
CL | — | — | May | — |
CM | — | — | May | — |
CN | — | — | May | — |
CO | — | — | May | — |
CP | — | — | May | — |
CR | — | — | May | — |
CS | — | — | May | — |
CU | — | — | May | — |
CV | — | — | May | — |
CW | — | — | May | — |
CX | — | — | May | — |
CY | — | — | May | — |
CZ | — | — | May | — |
DE | — | — | May | — |
DG | — | — | May | — |
DJ | — | — | May | — |
DK | — | — | May | — |
DM | — | — | May | — |
DO | — | — | May | — |
DZ | — | — | May | — |
EA | — | — | May | — |
EC | — | — | May | — |
EE | — | — | May | — |
EG | — | — | May | — |
EH | — | — | May | — |
ER | — | — | May | — |
ES | — | — | May | — |
ET | — | — | May | — |
EU | — | — | May | — |
FI | — | — | May | — |
FJ | — | — | May | — |
FK | — | — | May | — |
FM | — | — | May | — |
FO | — | — | May | — |
FR | — | — | May | — |
FX | — | — | May | — |
GA | — | — | May | — |
GB | — | — | May | — |
GD | — | — | May | — |
GE | — | — | May | — |
GF | — | — | May | — |
GG | — | — | May | — |
GH | — | — | May | — |
GI | — | — | May | — |
GL | — | — | May | — |
GM | — | — | May | — |
GN | — | — | May | — |
GP | — | — | May | — |
GQ | — | — | May | — |
GR | — | — | May | — |
GS | — | — | May | — |
GT | — | — | May | — |
GU | — | — | May | — |
GW | — | — | May | — |
GY | — | — | May | — |
HK | — | — | May | — |
HM | — | — | May | — |
HN | — | — | May | — |
HR | — | — | May | — |
HT | — | — | May | — |
HU | — | — | May | — |
IC | — | — | May | — |
ID | — | — | May | — |
IE | — | — | May | — |
IL | — | — | May | — |
IM | — | — | May | — |
IN | — | — | May | — |
IO | — | — | May | — |
IQ | — | — | May | — |
IR | — | — | May | — |
IS | — | — | May | — |
IT | — | — | May | — |
JE | — | — | May | — |
JM | — | — | May | — |
JO | — | — | May | — |
JP | — | — | May | — |
KE | — | — | May | — |
KG | — | — | May | — |
KH | — | — | May | — |
KI | — | — | May | — |
KM | — | — | May | — |
KN | — | — | May | — |
KP | — | — | May | — |
KR | — | — | May | — |
KW | — | — | May | — |
KY | — | — | May | — |
KZ | — | — | May | — |
LA | — | — | May | — |
LB | — | — | May | — |
LC | — | — | May | — |
LI | — | — | May | — |
LK | — | — | May | — |
LR | — | — | May | — |
LS | — | — | May | — |
LT | — | — | May | — |
LU | — | — | May | — |
LV | — | — | May | — |
LY | — | — | May | — |
MA | — | — | May | — |
MC | — | — | May | — |
MD | — | — | May | — |
ME | — | — | May | — |
MF | — | — | May | — |
MG | — | — | May | — |
MH | — | — | May | — |
MK | — | — | May | — |
ML | — | — | May | — |
MM | — | — | May | — |
MN | — | — | May | — |
MO | — | — | May | — |
MP | — | — | May | — |
MQ | — | — | May | — |
MR | — | — | May | — |
MS | — | — | May | — |
MT | — | — | May | — |
MU | — | — | May | — |
MV | — | — | May | — |
MW | — | — | May | — |
MX | — | — | May | — |
MY | — | — | May | — |
MZ | — | — | May | — |
NA | — | — | May | — |
NC | — | — | May | — |
NE | — | — | May | — |
NF | — | — | May | — |
NG | — | — | May | — |
NI | — | — | May | — |
NL | — | — | May | — |
NO | — | — | May | — |
NP | — | — | May | — |
NR | — | — | May | — |
NT | — | — | May | — |
NU | — | — | May | — |
NZ | — | — | May | — |
OM | — | — | May | — |
PA | — | — | May | — |
PE | — | — | May | — |
PF | — | — | May | — |
PG | — | — | May | — |
PH | — | — | May | — |
PK | — | — | May | — |
PL | — | — | May | — |
PM | — | — | May | — |
PN | — | — | May | — |
PR | — | — | May | — |
PS | — | — | May | — |
PT | — | — | May | — |
PW | — | — | May | — |
PY | — | — | May | — |
QA | — | — | May | — |
RE | — | — | May | — |
RO | — | — | May | — |
RS | — | — | May | — |
RU | — | — | May | — |
RW | — | — | May | — |
SA | — | — | May | — |
SB | — | — | May | — |
SC | — | — | May | — |
SD | — | — | May | — |
SE | — | — | May | — |
SF | — | — | May | — |
SG | — | — | May | — |
SH | — | — | May | — |
SI | — | — | May | — |
SJ | — | — | May | — |
SK | — | — | May | — |
SL | — | — | May | — |
SM | — | — | May | — |
SN | — | — | May | — |
SO | — | — | May | — |
SR | — | — | May | — |
SS | — | — | May | — |
ST | — | — | May | — |
SU | — | — | May | — |
SV | — | — | May | — |
SX | — | — | May | — |
SY | — | — | May | — |
SZ | — | — | May | — |
TA | — | — | May | — |
TC | — | — | May | — |
TD | — | — | May | — |
TF | — | — | May | — |
TG | — | — | May | — |
TJ | — | — | May | — |
TK | — | — | May | — |
TL | — | — | May | — |
TM | — | — | May | — |
TN | — | — | May | — |
TO | — | — | May | — |
TP | — | — | May | — |
TR | — | — | May | — |
TT | — | — | May | — |
TV | — | — | May | — |
TW | — | — | May | — |
TZ | — | — | May | — |
UA | — | — | May | — |
UG | — | — | May | — |
UK | — | — | May | — |
UM | — | — | May | — |
US | — | — | May | — |
UY | — | — | May | — |
UZ | — | — | May | — |
VA | — | — | May | — |
VC | — | — | May | — |
VE | — | — | May | — |
VG | — | — | May | — |
VI | — | — | May | — |
VN | — | — | May | — |
VU | — | — | May | — |
WF | — | — | May | — |
WS | — | — | May | — |
XK | — | — | May | — |
YE | — | — | May | — |
YT | — | — | May | — |
YU | — | — | May | — |
ZA | — | — | May | — |
ZM | — | — | May | — |
ZR | — | — | May | — |
ZW | — | — | May | — |
| ort00090 | City | string | May | — |
| ortsteil00100 | District | string | May | — |
| postfach00110 | PO box | string | May | — |
| postleitzahl00120 | Postal code | string | May | — |
| strasse00130 | Street | string | May | — |
Chain of this trigger
The event triggers the message.
| Message | Responses | Write call after the response |
|---|---|---|
| 19015 | — | — |
| 19016 | — | — |
This event triggers steps in these role views:
| Process | Party involved | Rulebook | Division |
|---|---|---|---|
| Device replacement | MSBA | AWH WiM gas 2.0 | Gas |
| Device replacement | MSBA | WiM electricity part 1 | Electricity |
Transaction data
The interchange envelope of the message. Mandatory fields must be set on the trigger call.
| Field | Type | Mandatory | Description |
|---|---|---|---|
| antwortstatus | string | yes | Response status / STS+E01 |
| antwortstatusCodeliste | string | yes | Response status code list / STS+E01 |
| kategorie | string | yes | Qualifier from the beginning of the EDIFACT message / BGM |
| sparte | Enum Sparte | yes | Contains information about the division Values: STROM, GAS, FERNWAERME, NAHWAERME, WASSER, ABWASSER |
pruefidentifikator | — | no | Determined dynamically in the event process (decision basis: antwortstatus). A value supplied by the sender is ignored. Check identifiers possible in the topic — 19015, 19016. Possible values: 19015, 19016 |
| absender › marktrolle | Enum Marktrolle | no | Specifies the designation of the market role as free text. Values: NB, LF, MSB, MSBA, GMSB, MDL, DL, BKV, UENB, KUNDE-SELBST-NN … (+9) |
| absender › rollencodenummer | string | no | Specifies the code value of the market role. |
| empfaenger › marktrolle | Enum Marktrolle | no | Specifies the designation of the market role as free text. Values: NB, LF, MSB, MSBA, GMSB, MDL, DL, BKV, UENB, KUNDE-SELBST-NN … (+9) |
| empfaenger › rollencodenummer | string | no | Specifies the code value of the market role. |
Additional data
eventname is fixed to START_ANTWORT_GERAETEWECHSEL. This value stays German in the English version as well, because Camunda correlates on it.
| Field | Type | Mandatory | Description |
|---|---|---|---|
prozessId | string | yes | — |
eventname | const START_ANTWORT_GERAETEWECHSEL | yes | — |
Response
The trigger assigns its own businessKey. The MACO APP adopts neither the businessKey nor the prozessId of the calling system as the identifier of the process instance. The businessKey of the response is created when the process starts and is new. The body of this call carries no businessKey field; there is thus no place where a key of your own could be passed in. The prozessId passed in (a mandatory field of this call) remains the document number of the backend: it comes back in zusatzdaten.prozessId of the callbacks — mandatory there only for MaloIdent (03002/03003), otherwise optional.
201 — Success. Success message for the process data API call.
| Field | Type | Mandatory | Description |
|---|---|---|---|
businessKey | string (uuid) | yes | Unique identifier of the business process |
message | string | yes | Message with details of the triggered event — example from the source: received event XXXXXXXXXXXX with id at 2024-08-08T12:58:22Z and started process with businessKey 4c7170ed-3518-41ee-8582-39ab65b00107 |
400 — Error. Error message for the process data API call.
| Field | Type | Mandatory | Description |
|---|---|---|---|
errorCode | string | no | Error identifier — example from the source: 400 |
message | string | no | Technical message — example from the source: Validation Failed |
Which body the callbacks updateProcessData and createProcessData send is measured against the NiFi flow of the MACO APP: {stammdaten, transaktionsdaten, zusatzdaten} without an interchange envelope, the businessKey inside zusatzdaten. This is not measured against a recorded call, and not for MaloIdent (03002/03003).
What distinguishes businessKey, prozessId and targetBusinessKey is explained on Keys and assignment.