...
| Titel | Auftrag (Providerwechsel / Verbundleistung) anlegen |
|---|
| Kurzbeschreibung | Folgender Ablauf beschreibt die typischen API Interaktionen zwischen dem aufnehmenden Auftrageber (EKPauf und TNBauf, aka AGauf), dem Leistungserbringer (LE, aka ANE) und dem abgebenden Auftraggeber (EKPab und TNBab, aka ABab) für die Anwendungsfälle "Auftrag (Providerwechsel / Verbundleistung) anlegen - Schlechtfall Negative RespondProviderChange (RUEM-PV)". Zu diesen Anwendungsfall sind zwei Sequenzen relevant: - Die Vorabstimmung
- Die Durchführung
|
|---|
| Vorbedingung | - Rahmenverträge und Dienstverträge sind vorhanden
- Der Auftraggeber hat die Verfügbarkeit des Produktes geprüft
- der AGab hat sich beim LE für Kündigungen durch den Leistungserbringer registriert (siehe Auftrag (Kündigung durch LE, GF PV/VBL) anlegen)
|
|---|
| Auslöser | Der aufnehmende Auftraggeber legt einen Auftrag für den Providerwechsel bzw. die Verbundleistung beim Leistungserbringer (ANE) an. Schlechtfall:Am Schalttag kann die Bereitstellung nicht erfolgen. |
|---|
| Ergebnis | Der Leistungserbringer fordert beim aufnehmenden Provider Auftraggeber einen neuen Termin an (Status "Pending" - Information Required (TAM)) Der Leistungserbringer sendet an den abgebenden Provider Auftraggeber eine Verzögerungsmeldung (ProcessingMessage JeopardyMessage "OrderDelayorderDelay", (VZM-PV)), hier nicht dargestellt Nach erfolgter Terminverschiebung durch den aufnehmenden Auftraggeber sendet der Leistungserbringer an den abgebenden Auftraggeber eine Information über den neuen Bereitstellungstermin: MilestoneEvent "orderConfirmationUpdate", (erneute ABM-PV) Der weitere Verlauf wird hier nicht mehr betrachtet. |
|---|
Ablauf
Variante erfolgreiche Schaltung nach Terminanforderung
| Bitbucket file macro |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/assets/ProviderChange_FailedOnSwitchDay.puml |
|---|
| syntaxHighlighting | PlantUML |
|---|
|
Beispieldaten (linker Block, TNBauf ↔ ANE)
| Erweitern |
|---|
| title | 1) Post ProductOrder (providerChange) - identisch zum Gutfall |
|---|
|
|
| Erweitern |
|---|
| title | 2) ProductOrderStateChangeEvent: Accepted - identisch zum Gutfall |
|---|
|
|
| Erweitern |
|---|
| title | vor 5) ProductOrderAttributeValueChange - identisch zum Gutfall |
|---|
|
|
| Erweitern |
|---|
| title | 5) ProductOrderStateChangeEvent: inProgress - identisch zu Gutfall und Geschäftsfall Neu |
|---|
|
|
ProductOrderStateChangeEvent: pending (11)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-provider-change-4c-state-change-event-pending.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| ProductOrderStateChangeEvent: pending |
| fachliche Felder | Daten | API Felder |
| Orderstatus | pending | state |
| fachliches Änderungsdatum | 2022-12-16T11:30:00+01:00 | stateChangeDate |
| technisches EventDatum | 2022-12-16T11:30:00+01:00 | eventTime |
| Grund der Änderung | 6001 "Endkunde nicht angetroffen" | stateChangeReason.code stateChangeReason.description |
ProductOrderInformationRequiredEvent (14)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-provider-change-5b-information-required-event-requested-completion-date.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| fachliche Felder | Daten | API Felder |
|---|
| Feld, zu dem eine Information benötigt wird | /requestedCompletionDate replace | fieldPath.path fieldPath.typeOfChange |
POST RescheduleProductOrder (15)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/reschedule-product-order-provider-change-0.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| fachliche Felder | Daten | API Felder |
|---|
| Verschobener Kundenwunschtermin | 2022-12-19T12:00:00+01:00 | rescheduledRequestedCompletionDate |
| Wunschzeitfenster | 2022-12-19T08:00:00+01:00 2022-12-19T12:00:00+01:00
| productOrderItem.requestedTimeSlot.validFor.startDateTime productOrderItem.requestedTimeSlot.validFor.endDateTime |
POST RescheduleProductOrderStateChangeEvent: inProgress (17)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/reschedule-product-order-provider-change-2-state-change-event-in-progress.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| fachliche Felder | Daten | API Felder |
|---|
| technisches EventDatum | 2022-12-16T11:40:10+01:00 | eventTime |
| Orderstatus | inProgress | event.rescheduleProductOrder.state |
| Orderstatus Änderungsdatum | 2022-12-16T11:40:10+01:00 | event.rescheduleProductOrder.stateChangeDate |
POST ProductOrderAttributeValueChangeEvent (18)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-provider-change-6b-attribute-value-change-event-requested-completion-date.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| fachliche Felder | Daten | API Felder |
|---|
| technisches EventDatum | 2022-12-16T11:40:20+01:00 | eventTime |
| Kundenwunschtermin | 2022-12-19T12:00:00+01:00 | event.productOrder.requestedCompletionDate |
| Wunschzeitfenster | 2022-12-19T08:00:00+01:00 2022-12-19T12:00:00+01:00 | event.productOrder.productOrderItem.requestedTimeSlot.validFor.startDateTime event.productOrder.productOrderItem.requestedTimeSlot.validFor.endDateTime |
POST RescheduleProductOrderStateChangeEvent: done (19)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/reschedule-product-order-provider-change-3-state-change-event-done.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| fachliche Felder | Daten | API Felder |
|---|
| technisches EventDatum | 2022-12-16T11:40:20+01:00 | eventTime |
| Orderstatus | done | event.rescheduleProductOrder.state |
| Orderstatus Änderungsdatum | 2022-12-16T11:40:20+01:00 | event.rescheduleProductOrder.stateChangeDate |
ProductOrderAttributeValueChangeEvent (20)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-provider-change-7-attribute-value-change-event-expected-completion-date.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| fachliche Felder | Daten | API Felder |
|---|
| technisches EventDatum | 2022-12-16T11:40:25+01:00 | eventTime |
| Verbindlicher Liefertermin | 2022-12-19T12:00:00+01:00 | event.productOrder.expectedCompletionDate |
| Vereinbartes Zeitfenster | 2022-12-19T08:00:00+01:00 2022-12-19T12:00:00+01:00 | event.productOrder.productOrderItem.appointment.validFor.startDateTime event.productOrder.productOrderItem.appointment.validFor.endDateTime |
ProductOrderStateChangeEvent: inProgress (21)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-provider-change-8-state-change-event-in-progress.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| ProductOrderStateChangeEvent: inProgress |
| fachliche Felder | Daten | API Felder |
| Orderstatus | inProgress | state |
| fachliches Änderungsdatum | 2022-12-16T11:40:30+01:00 | stateChangeDate |
| technisches EventDatum | 2022-12-16T11:40:30+01:00 | eventTime |
| Grund der Änderung | 0011 "Montage beim Endkunden erforderlich." | stateChangeReason.code stateChangeReason.description |
ProductOrderStateChangeEvent: completed (25)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-provider-change-9-state-change-event-completed.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| ProductOrderStateChangeEvent: completed |
| fachliche Felder | Daten | API Felder |
| Orderstatus | completed | state |
| fachliches Änderungsdatum | 2022-12-19T10:00:00+01:00 | stateChangeDate |
| technisches EventDatum | 2022-12-19T10:00:00+01:00 | eventTime |
| Grund der Änderung | 0010 "Auftrag ausgeführt." | stateChangeReason.code stateChangeReason.description |
ProductOrderAttributeValueChange (28)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-provider-change-10-attribute-value-change-event-start-date.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| ProductOrderAttributeValueChange (setzen von startDate) |
| fachliche Felder | Daten | API Felder |
| technisches EventDatum | 2022-12-19T10:00:30+01:00 | eventTime |
| Nutzungsdatum | 2022-12-19T10:00:00+01:00 | product.startDate |
ProductOrderStateChangeEvent: closed (29)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-provider-change-11-state-change-event-closed.json |
|---|
| syntaxHighlighting | JSON |
|---|
|
| ProductOrderStateChangeEvent: closed |
| fachliche Felder | Daten | API Felder |
| Orderstatus | closed | state |
| fachliches Änderungsdatum | 2022-12-19T10:01:00+01:00 | stateChangeDate |
| technisches EventDatum | 2022-12-19T10:01:00+01:00 | eventTime |
| Grund der Änderung | 0010 "Auftrag ausgeführt." | stateChangeReason.code stateChangeReason.description |
Variante LineInUse
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/assets/ProviderChange_FailedOnSwitchDay_WithLineInUse.puml |
|---|
| syntaxHighlighting | PlantUML |
|---|
|
hierzu wird kein Beispiel erzeugt
Variante Cancel
| Bitbucket file macro |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/assets/ProviderChange_FailedOnSwitchDay_WithCancel.puml |
|---|
| syntaxHighlighting | PlantUML |
|---|
|
hierzu wird kein Beispiel erzeugt
