Inhalt |
---|
Beschreibung
Titel | Auftrag abbrechen |
---|---|
Kurzbeschreibung | Folgender Ablauf beschreibt die typischen API- Interaktionen zwischen Auftraggeber Auftrageber und Leistungserbringer im Anwendungsfall "Auftrag abbrechen". Der Leistungserbringer bricht Auftragsrealisierung die Auftragsbearbeitung ab und meldet dem Auftraggeber den Abbruch zurück. Dabei werden die für diesen Ablauf erforderlichen Auftrags-Status durchlaufen und die für diesen Ablauf relevanten Informationen übermittelt. |
Vorbedingung | Der abzubrechende Auftrag wurde angelegt und ist noch nicht abgeschlossen ( d.h. der Auftrag befindet sich initial nicht in den Auftrags-Status closed, rejected or failed) |
Auslöser | Folgende Auslöser des Auftragsabbruches können vorkommenEs gibt folgende Auslöser eines Auftragsabbruchs:
|
Ergebnis | Die Bereitstellung wurde abgebrochen und der Abbruch dem Auftraggeber gemeldet |
Ablauf
Img | ||
---|---|---|
|
Codeblock | ||||
---|---|---|---|---|
| ||||
@startuml
autonumber
box Buyer
participant b as "Ordering"
box Seller TMF622
participant po as "ProductOrder"
alt Abbruch bei kaufmännischer Validierung
po -> b: POST ProductOrderAttributeValueChangeEvent()
note right: e.g.: productOrderItem.alternateProductOffering.name
po -> b: POST ProductOrderStateChangeEvent(rejected)
note right: ABBM
else Abbruch bei technischer Validierung/Erteilung
po -> b: POST ProductOrderStateChangeEvent(rejected)
note right: ABBM
else Abbruch bei erfolgloser TAM und MTAM
po -> b: POST ProductOrderStateChangeEvent(cancelled)
note right: ABBM
else Abbruch bei Auftragsrealisierung
po -> b: POST ProductOrderAttributeValueChangeEvent()
note right: e.g.: earliestOrderRetry
po -> b: POST ProductOrderStateChangeEvent(failed)
note right: ABBM
end
@enduml |
...
Business Rule
...
. Der Auftrag befindet sich final in einem der folgenden Auftrags-Status:
|
Ablauf
Bitbucket file macro | ||||
---|---|---|---|---|
|
Der Fehlschlag während der Realisierung für die category VBL oder PV ist im Detail hier dargestellt: 2) Fehlschlag beim Leistungserbringer
Besonderheit
Im Geschäftsfall "KUE-LE" (catogory: terminationBySeller) gibt es nur den Ablauf "Scheitern der Auftragsrealisierung" (siehe Beschreibung, Auslöser).
...
werden im Geschäftsfall "KUE-LE" nicht unterstützt.
Beispieldaten
ProductOrderAttributeValueChange (Alternativprodukt/korrigierter Standort)
...
(1)
Bitbucket file macro collapsible true url https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-1b-attribute-value-change-event-alternate-offering.json syntaxHighlighting JSON
fachliche Felder | Daten | API Felder |
---|---|---|
technisches Eventdatum | 2022-05-11T10:30:30+02:00 | eventTime |
Wiedervorlagetermin | 2023-01-16T10:00:00+01:00 | earliestOrderRetry |
Alternativprodukt | alternateProductOffering | |
FTTH L2 PON 1500 1000 | name | |
StandortA Korrektur | RelatedPlaceRefOrValue | |
AlternateAddress | role | |
Rheinhausen | city | |
DEU | country | |
59055 | postcode | |
Biberweg | streetName | |
2 | streetNr | |
b | streetNrSuffix |
ProductOrderStateChangeEvent: Abbruch bei kaufmännischer/technischer Validierung (2)
Bitbucket file macro collapsible true url https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-
...
1c-
...
state-
...
change-event-
...
rejected.json
...
syntaxHighlighting JSON
fachliche Felder | Daten | API Felder |
---|---|---|
orderstatus | rejected | state |
fachliches Änderungsdatum | 2022-05-11T10:31:00 |
stateChangeDate |
technisches EventDatum | 2022-05-20T10:40:00+01:00 | eventTime |
Grund der Änderung | "1001" "Die Anschrift ist nicht bekannt." | stateChangeReason.code stateChangeReason.text |
ProductOrderAttributeValueChange (Wiedervorlagedatum) (3)
Bitbucket file macro collapsible true url https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-
...
1b-attribute-
...
value-change-event-earliest-
...
order-retry.json
...
syntaxHighlighting
...
JSON
fachliche Felder |
---|
Daten |
---|
API Felder |
---|
technisches Eventdatum | 2022-05-11T10:30:30 | eventTime |
Wiedervorlagetermin | 2023-01-16T10:00:00+01:00 | earliestOrderRetry |
ProductOrderStateChangeEvent: Abbruch bei kaufmännischer/technischer Validierung (4)
Bitbucket file macro collapsible true url https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-
...
1c-state-change-event-
...
rejected.json
...
syntaxHighlighting
...
JSON
fachliche Felder |
---|
Daten |
---|
API Felder |
---|
technisches EventDatum | 2022-05-11T10:31:00+02:00 | eventTime |
orderstatus | rejected | state |
fachliches Änderungsdatum | 2022-05-11T10:31:00 |
stateChangeDate | ||
Grund der Änderung | "1023" "Ihr Auftrag ist derzeit aus technischen Gründen nicht bearbeitbar. Bitte versuchen Sie es zu einem späteren Zeitpunkt erneut." | stateChangeReason.code stateChangeReason.text |
ProductOrderStateChangeEvent: nach erfolgloser TAM/MTAM (5)
Bitbucket file macro collapsible true url https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-
...
1a-state-change-event-
...
cancelled.json
...
syntaxHighlighting
...
JSON
fachliche Felder |
---|
Daten |
---|
API Felder |
---|
technisches EventDatum | 2022-06-13T10:42:00+02:00 | eventTime |
orderstatus | cancelled | state |
fachliches Änderungsdatum | 2022-05-11T10: |
31:00 |
stateChangeDate | ||
Grund der Änderung | "1198" "Es wurde kein neuer Ausführungstermin übermittelt." | stateChangeReason.code stateChangeReason.text |
ProductOrderStateChangeEvent: Abbruch bei Auftragsrealisierung (6)
Bitbucket file macro collapsible true url https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-
...
1e-
...
state-change-event-
...
failed.json
...
syntaxHighlighting
...
JSON
fachliche Felder |
---|
Daten |
---|
API Felder |
---|
technisches EventDatum | 2022-05-11T10:31:00+02:00 | eventTime |
orderstatus | failed | state |
fachliches Änderungsdatum | 2022-05-11T10:31:00 | stateChangeDate |
Grund der Änderung | "1305" "Es wurde kein neuer Ausführungstermin übermittelt." | stateChangeReason.code stateChangeReason.text |