Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

TitelAuftrag stornieren
Kurzbeschreibung

Folgender Ablauf beschreibt die typischen Interaktionen zwischen Auftraggeber und Leistungserbringer im Anwendungsfall "Auftrag stornieren".

Der Auftraggeber beantragt die Stornierung eines laufenden Auftrages beim Leistungserbringer. Der Leistungserbringer prüft den Antrag und kann diesen zurückweisen oder umsetzen. 

Dabei werden die für diesen Ablauf erforderlichen Auftrags-Status durchlaufen und die für diesen Ablauf relevanten Informationen übermittelt.

Vorbedingung

Der zu stornierende Auftrag wurde angelegt und ist noch nicht abgeschlossen. Das heißt, er befindet sich in keinem der folgenden Status: completed, closed, rejected, failed oder cancelled.

Darüber hinaus muss die kaufmännische Validierung abgeschlossen sein, so dass sich der Auftrag nicht mehr im Status achnowledged befindet.

Durch Versand des Milestones mit dem name = pointOfNoReturn kann der Leistungserbringer darüber hinaus den Zeitraum für den Versand eines Stornos weiter einschrämken.

Auslöser

Der Auftraggeber beantragt die Stornierung eines laufenden Auftrages beim Leistungserbringer durch Erzeugung einer Task Resource vom Typ CancelProductOrder.

Ergebnis

Der Anwendungsfall hat zwei mögliche Ergebnisse:

  • Die Bereitstellung wurde storniert und die Stornierung dem Auftraggeber gemeldet
  • Der Stornoantrag wurde zurückgewiesen und der Bereitstellungsauftrag läuft weiter

...

ProductOrderMilestoneEvent (PONR) (1)

StashincludebyfilepathrepoSlugfit-rootbranchIdrefs/heads/mainprojectKeyTFITfilepathtmf622/examples/ftth-no-opts

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-4e-milestone-event-point-of-no-return.json
showLineNumberstrueprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
syntaxHighlightingJSON

ProductOrderMilestoneEvent
FelderDatenAPI Feld

technisches Event Datum

2022-05-12T08:45:00+02:00EventTime
Typ des Product Order Milestone EventspointOfNoReturnname
Datum und Uhrzeit des Milestones2022-05-12T08:45:00+02:00milestoneDate
Meldecode des Milestones1087milestoneMessage.code
Meldungstext des MilestonesEine Stornierung ist nicht möglich. milestoneMessage.text

Post CancelProductOrder (2)

...

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/cancel-product-order-0-create.json
showLineNumberstrueprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T08:45:00+02:00EventTime
zu stornierende Order (bekannt durch Events aus der Order durch LE gesetzt)388a4963-f168-4603-99e8-477200099d91productOrder.id

...

Response (

...

3)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/cancel-product-order-1-pos.json
syntaxHighlightingJSON

CancelProductOrderStateChangeEvent: inProgress (4)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/cancel-product-order-2-pos-state-change-event-in-progress.json
showLineNumberstrueprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:30:00+02:00EventTime

Cancel Status Wechsel auf inProgress

Status:

Eventdate:


inProgress

2022-05-11T11:30:00+02:00


CancelProductOrder.state

CancelProductOrder.stateChangeDate

Storno zurückgewiesen

CancelProductOrderStateChangeEvent: rejected (5)

...

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/cancel-product-order-3-rej-state-change-event-rejected.json
showLineNumberstrueprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:32:00+02:00EventTime

Cancel Status Wechsel auf rejected

Status:

Eventdate:

Meldecode:

Meldetext:


rejected

2022-05-11T11:32:00+02:00

1087

"Eine Stornierung ist nicht möglich. "


CancelProductOrder.state

CancelProductOrder.stateChangeDate

CancelProductOrder.stateChangeReason.code

CancelProductOrder.stateChangeReason.text

Antrag wird bearbeitet/ Auftrag wird storniert

POST ProductOrderStateChangeEvent: assessingCancellation (6)

...


Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-cpo1-state-change-event-assessing-cancellation.json
showLineNumbersprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
syntaxHighlighting
true
JSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:32:00+02:00EventTime

Auftrag Status Wechsel assessingCancellation

Typ der Meldung:

Status:

Eventdate:


ProductOrderStateChangeEvent

assessingCancellation

2022-05-12T11:32:00+02:00


ProductOrderStateChangeEvent/@type

ProductOrder.state

ProductOrder.stateChangeDate

...

POST ProductOrderAttributeValueChangeEvent (orderIsChargingRelevant) (9)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-cpo1a-attribute-value-change-event-order-is-charging.json

...

syntaxHighlighting

...

JSON
 

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:33:00+02:00EventTime

Storno ist kostenpflichtig (optional)

Typ der Meldung:

Kostenpflichtiger Vorgang:

Eventdate:


ProductOrderAttributeValueChangeEvent

True

2022-05-12T11:33:00


ProductOrderAttributeValueChangeEvent/@type@type

ProductOrder.orderIsChargingRelevant

ProductOrderAttributeValueChangeEvent.eventTime

...

POST ProductOrderStateChangeEvent: cancelled (10)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-cpo2-state-change-event-cancelled.json
showLineNumberstrueprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d (8)
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:34:00+02:00EventTime

Auftrag Status Wechsel cancelled

Typ der Meldung:

Status:

Eventdate:

Meldecode:

Meldetext:


ProductOrderStateChangeEvent

cancelled

2022-05-12T11:34:00+02:00

"0017"

"Stornierung durchgeführt."


ProductOrderStateChangeEvent/@type

ProductOrder.state

ProductOrder.stateChangeDate

ProductOrder.stateChangeReason.code

ProductOrder.stateChangeReason.description

...

POST CancelProductOrderStateChangeEvent: done

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/cancel-product-order-3-pos-state-change-event-done.json
showLineNumberstrueprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d(10)
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:35:00+02:00EventTime

Cancel Status Wechsel auf Done

Typ der Meldung:

Status:

Eventdate:

Meldecode:

Meldetext:


CancelProductOrderStateChangeEvent

done

2022-05-12T11:35:00+02:00

"0012" 

"Stornoauftrag erfolgreich"


CancelProductOrderStateChangeEvent/@type

CancelProductOrder.state

CancelProductOrder.stateChangeDate

CancelProductOrder.stateChangeReason.code

CancelProductOrder.stateChangeReason.text

Antrag wird bearbeitet / Auftrag ist nicht storniert

...

ProductOrderStateChangeEvent: assessingCancellation (6)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-
cpo3
cpo1-state-change-event-assessing-cancellation.json
showLineNumberstrueprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:32:00+02:00EventTime

Auftrag Status Wechsel assessingCancellation

Typ der Meldung:

Status:

Eventdate:


ProductOrderStateChangeEvent

assessingCancellation

2022-05-12T11:32:00+02:00


ProductOrderStateChangeEvent/@type

ProductOrder.state

ProductOrder.stateChangeDate

...

ProductOrderStateChangeEvent: inProgress

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-cpo4-state-change-event-in-
acknowledged
progress.json
showLineNumberstrueprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:33:00+02:00EventTime

Auftrag Status Wechsel auf den vorherigen Auftragsstatus

Typ der Meldung:

Status:

Eventdate:


ProductOrderStateChangeEvent

accepted, inProgress oder pending

2022-05-12T11:33:00+02:00


ProductOrderStateChangeEvent/@type

ProductOrder.state

ProductOrder.stateChangeDate

...

POST CancelProductOrderStateChangeEvent: rejected (8)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/cancel-product-order-3-
neg
rej-state-change-event-
done
rejected.json
showLineNumberstrueprogLangplaincollapsibletrueapplicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:32:00+02:00EventTime

Cancel Status Wechsel auf rejected

Status:

Eventdate:

Meldecode:

Meldetext:


rejected

2022-05-11T11:32:00+02:00

1087

"Eine Stornierung ist nicht möglich. "


CancelProductOrder.state

CancelProductOrder.stateChangeDate

CancelProductOrder.stateChangeReason.code

CancelProductOrder.stateChangeReason.text

...