Complaint about the overview of the…

START_REKLAMATION_DEFINITION (MSB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (4):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "AUFTRAG": [
      {
        "positionsdaten": [
          {
            "definitionsTyp": "ZAEHLZEIT",
            "positionsnummer": 0
          }
        ]
      }
    ],
    "LEISTUNGSKURVENDEFINITION": [
      {
        "leistungskurven": [
          {
            "code": "code"
          }
        ]
      }
    ],
    "REKLAMATION": [
      {
        "reklamationsgrund": "WERTE_ZU_HOCH",
        "reklamationsgrundBemerkung": {
          "bemerkung1": "bemerkung1",
          "bemerkung2": "bemerkung2",
          "bemerkung3": "bemerkung3",
          "bemerkung4": "bemerkung4",
          "bemerkung5": "bemerkung5"
        }
      }
    ],
    "SCHALTZEITDEFINITION": [
      {
        "schaltzeiten": [
          {
            "code": "code"
          }
        ]
      }
    ],
    "ZAEHLZEITDEFINITION": [
      {
        "zaehlzeiten": [
          {
            "code": "code"
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "pruefidentifikator": "17122"
  },
  "zusatzdaten": {
    "eventname": "START_REKLAMATION_DEFINITION",
    "prozessId": "prozessId"
  }
}'

START_REKLAMATION_DEFINITION (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	17122
stammdaten*	—	object	Muss
AUFTRAG[ ]*	—	object[]	Muss
positionsdaten[ ]*	—	object[]	Muss
`definitionsTyp`*00010	DefinitionsType	string	Muss
`ZAEHLZEIT`			Muss
`SCHALTZEIT`			Muss
`LEISTUNGSKURVEN`			Muss
`positionsnummer`*00020	Line item number	integer	Muss
LEISTUNGSKURVENDEFINITION[ ]	—	object[]	Kann
leistungskurven[ ]	—	object[]	Kann
`code`00030	Code of the power curve	string	Kann
REKLAMATION[ ]*	—	object[]	Muss
`reklamationsgrund`*00040	This specifies the reason for the complaint about values.	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`00050	bemerkung1	string	Kann
`bemerkung2`00060	bemerkung2	string	Kann
`bemerkung3`00070	bemerkung3	string	Kann
`bemerkung4`00080	bemerkung4	string	Kann
`bemerkung5`00090	bemerkung5	string	Kann
SCHALTZEITDEFINITION[ ]	—	object[]	Kann
schaltzeiten[ ]	—	object[]	Kann
`code`00100	Code of the power curve	string	Kann
ZAEHLZEITDEFINITION[ ]	—	object[]	Kann
zaehlzeiten[ ]	—	object[]	Kann
`code`00110	Code of the power curve	string	Kann
transaktionsdaten*	—	object	Muss
`pruefidentifikator`00120	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 17122.	—	Kann
zusatzdaten*	—	object	Muss
`eventname`*00130	—	string	Muss
`prozessId`*00140	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "AUFTRAG": [
      {
        "positionsdaten": [
          {
            "definitionsTyp": "ZAEHLZEIT",
            "positionsnummer": 0
          }
        ]
      }
    ],
    "LEISTUNGSKURVENDEFINITION": [
      {
        "leistungskurven": [
          {
            "code": "code"
          }
        ]
      }
    ],
    "REKLAMATION": [
      {
        "reklamationsgrund": "WERTE_ZU_HOCH",
        "reklamationsgrundBemerkung": {
          "bemerkung1": "bemerkung1",
          "bemerkung2": "bemerkung2",
          "bemerkung3": "bemerkung3",
          "bemerkung4": "bemerkung4",
          "bemerkung5": "bemerkung5"
        }
      }
    ],
    "SCHALTZEITDEFINITION": [
      {
        "schaltzeiten": [
          {
            "code": "code"
          }
        ]
      }
    ],
    "ZAEHLZEITDEFINITION": [
      {
        "zaehlzeiten": [
          {
            "code": "code"
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "pruefidentifikator": "17122"
  },
  "zusatzdaten": {
    "eventname": "START_REKLAMATION_DEFINITION",
    "prozessId": "prozessId"
  }
}

json

START_REKLAMATION_DEFINITION (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_REKLAMATION_DEFINITION 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 104 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.

START_PARTIN START_VERSAND_ANF_STORNO

START_REKLAMATION_DEFINITION (MSB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (4):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "AUFTRAG": [
      {
        "positionsdaten": [
          {
            "definitionsTyp": "ZAEHLZEIT",
            "positionsnummer": 0
          }
        ]
      }
    ],
    "LEISTUNGSKURVENDEFINITION": [
      {
        "leistungskurven": [
          {
            "code": "code"
          }
        ]
      }
    ],
    "REKLAMATION": [
      {
        "reklamationsgrund": "WERTE_ZU_HOCH",
        "reklamationsgrundBemerkung": {
          "bemerkung1": "bemerkung1",
          "bemerkung2": "bemerkung2",
          "bemerkung3": "bemerkung3",
          "bemerkung4": "bemerkung4",
          "bemerkung5": "bemerkung5"
        }
      }
    ],
    "SCHALTZEITDEFINITION": [
      {
        "schaltzeiten": [
          {
            "code": "code"
          }
        ]
      }
    ],
    "ZAEHLZEITDEFINITION": [
      {
        "zaehlzeiten": [
          {
            "code": "code"
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "pruefidentifikator": "17122"
  },
  "zusatzdaten": {
    "eventname": "START_REKLAMATION_DEFINITION",
    "prozessId": "prozessId"
  }
}'

START_REKLAMATION_DEFINITION (MSB) › Request Body

Structure (BO4E)	Description	Format	17122
stammdaten*	—	object	Muss
AUFTRAG[ ]*	—	object[]	Muss
positionsdaten[ ]*	—	object[]	Muss
`definitionsTyp`*00010	DefinitionsType	string	Muss
`ZAEHLZEIT`			Muss
`SCHALTZEIT`			Muss
`LEISTUNGSKURVEN`			Muss
`positionsnummer`*00020	Line item number	integer	Muss
LEISTUNGSKURVENDEFINITION[ ]	—	object[]	Kann
leistungskurven[ ]	—	object[]	Kann
`code`00030	Code of the power curve	string	Kann
REKLAMATION[ ]*	—	object[]	Muss
`reklamationsgrund`*00040	This specifies the reason for the complaint about values.	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`00050	bemerkung1	string	Kann
`bemerkung2`00060	bemerkung2	string	Kann
`bemerkung3`00070	bemerkung3	string	Kann
`bemerkung4`00080	bemerkung4	string	Kann
`bemerkung5`00090	bemerkung5	string	Kann
SCHALTZEITDEFINITION[ ]	—	object[]	Kann
schaltzeiten[ ]	—	object[]	Kann
`code`00100	Code of the power curve	string	Kann
ZAEHLZEITDEFINITION[ ]	—	object[]	Kann
zaehlzeiten[ ]	—	object[]	Kann
`code`00110	Code of the power curve	string	Kann
transaktionsdaten*	—	object	Muss
`pruefidentifikator`00120	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 17122.	—	Kann
zusatzdaten*	—	object	Muss
`eventname`*00130	—	string	Muss
`prozessId`*00140	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "AUFTRAG": [
      {
        "positionsdaten": [
          {
            "definitionsTyp": "ZAEHLZEIT",
            "positionsnummer": 0
          }
        ]
      }
    ],
    "LEISTUNGSKURVENDEFINITION": [
      {
        "leistungskurven": [
          {
            "code": "code"
          }
        ]
      }
    ],
    "REKLAMATION": [
      {
        "reklamationsgrund": "WERTE_ZU_HOCH",
        "reklamationsgrundBemerkung": {
          "bemerkung1": "bemerkung1",
          "bemerkung2": "bemerkung2",
          "bemerkung3": "bemerkung3",
          "bemerkung4": "bemerkung4",
          "bemerkung5": "bemerkung5"
        }
      }
    ],
    "SCHALTZEITDEFINITION": [
      {
        "schaltzeiten": [
          {
            "code": "code"
          }
        ]
      }
    ],
    "ZAEHLZEITDEFINITION": [
      {
        "zaehlzeiten": [
          {
            "code": "code"
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "pruefidentifikator": "17122"
  },
  "zusatzdaten": {
    "eventname": "START_REKLAMATION_DEFINITION",
    "prozessId": "prozessId"
  }
}

json

START_REKLAMATION_DEFINITION (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_REKLAMATION_DEFINITION der Marktrolle MSB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

Feedback on the documentation

Feedback on the documentation

Complaint about the overview of the…

START_REKLAMATION_DEFINITION (MSB)

START_REKLAMATION_DEFINITION (MSB) › Request Body

START_REKLAMATION_DEFINITION (MSB) › Responses

Complaint about the overview of the…

START_REKLAMATION_DEFINITION (MSB)

START_REKLAMATION_DEFINITION (MSB) › Request Body

START_REKLAMATION_DEFINITION (MSB) › Responses