[MSB] START_ENDE_MSB
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: 44051.
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_55051 | UTILMD | End of MSB | WiM electricity part 1 | MSB (corresponds to MSBA on the object metering location) → NB |
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 | 55051 | Condition |
|---|---|---|---|---|
| stammdaten | — | object | May | — |
| MESSLOKATION [ ] * | — | object[] | Must | — |
| messlokationsId *00010 | The metering location identification. This is the former metering point identifier, e.g. DE 47108151234567 | string | Must | — |
| NETZNUTZUNGSVERTRAG [ ] | — | object[] | May | — |
| vertragsbeginn00020 | Specifies when the contract begins. | string (date-time) | May | — |
| vertragsende00030 | Specifies when the contract (is expected to) end or was ended. | string (date-time) | May | — |
Chain of this trigger
The event triggers the message. The market partner responds with one of the responses listed, and after that the MACO APP writes the transaction to your backend system.
| Message | Responses | Write call after the response |
|---|---|---|
| 55051 | 55052, 55053 | POST /updateProcessData |
44051 | — | — |
This event triggers a step in this role view:
| Process | Party involved | Rulebook | Division |
|---|---|---|---|
| End of metering point operation | 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 |
|---|---|---|---|
pruefidentifikator | — | no | Determined dynamically in the event process (decision basis: sparte). A value supplied by the sender is ignored. Check identifiers possible in the topic — 44051, 55051. Possible values: 44051, 55051 |
Additional data
eventname is fixed to START_ENDE_MSB. 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_ENDE_MSB | 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.