Versionen im Vergleich

Schlüssel

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

Beschreibung

Titel

Auftrag (Kündigung durch LE) anlegen

Kurzbeschreibung

Folgender Ablauf beschreibt die typischen Interaktionen zwischen Auftraggeber und Leistungserbringer im Anwendungsfall "Auftrag (Kündigung durch LE) anlegen".

Dieser Anwendungsfall behandelt die Kündigung eines Produktes durch den Leistungserbringer.

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

Vorbedingung

  • Die Kündigung muss sich auf ein im Bestand des jeweiligen Auftraggebers befindliches Produkt beziehen.

  • Voraussetzung für den Geschäftsfall "Kündigung durch Leistungserbringer" ist ein bestehender Rahmenvertrag zwischen dem Auftraggeber und dem Leistungserbringer.

  • Mindestens alle Pflichtfelder für eine Product Order im Anwendungsfall "Auftrag (Kündigung durch LE) anlegen" sind laut Auftrags-/Meldungsstruktur (download) gefüllt.

  • Liegt ein offener Auftrag eines Auftraggebers zum betroffenen Bestand (z.B. für den Anschluss oder dem Übertragungsweg) vor, wird dieser mit Hinweis auf die Kündigung durch den Leistungserbringer abgebrochen.

Auslöser

Der Leistungserbringer legt sich selber einen Kündigungsauftrag an.

Der Auftraggeber wird durch Erzeugung eines ProductOrderCreateEvents über den neuen Kündigungsauftrags informiert.

Ergebnis

Das Produkt wurde gekündigt

Ablauf

Bitbucket file macro
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/assets/UC_KUE-LE.puml
syntaxHighlightingPlantUML

Beispieldaten

POST ProductOrder (1)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-termination-pv-0.json
syntaxHighlightingJSON

fachliche Felder

Daten 

API Felder

technische Daten

fachliches Bestelldatum des AG

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

productOrder.orderPostedDate

Geschäftsfall Name

terminationBySeller

productOrder.category

Produktdaten

Aktion

delete

productOrderItem.action

Produkt-ID

922ebf01-e930-47a0-842e-059d1f188a15

ProductOrderItem/product.id

Vertragsnummer 

3091231119

ProductOrder/agreement.businessId = "3091231119"
ProductOrder/agreement.agreementType="singleContract"

ProductOrder/agreement.name="singleContract"

Auftragsdaten

Kündigungstermin

2022-12-01T12:00:00+01:00
(Uhrzeit fachlich nicht relevant, aber technisch erforderlich)

ProductOrter.requestedCompletionDate

Auftraggeberdaten (werden teilweise nicht gefüllt, da der Kündigungsauftrag vom LE eingestellt wird)

Leistungs-Nummer

500012

Agreement.businessId (agreementType = buyerServiceContract)

Auftraggeber-Nummer

500011

Agreement.engagedParty.businessId

RelatedParty mit role ="orderManagementBuyerContact" und externe Auftragsnummer wird nicht gefüllt, da der Kündigungsauftrag vom LE eingestellt wird

ProductOrderStateChangeEvent: Accepted (4)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-termination-pv-1-state-change-event-accepted.json
syntaxHighlightingJSON

fachliche Felder

Daten 

API Felder

technisches EventDatum

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

eventTime

Orderstatus 

accepted

state 

OrderstatusChangeDate

2022-05-11T10:31:00+02:00

stateChangeDate 

Grund der Änderung

0000

"Keine Änderung zum Auftrag"

stateChangeReason.code

stateChangeReason.description

ProductOrderAttributeValueChange (setzen von Auftragsmanagment & VLT, (5))

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-termination-pv-2-attribute-value-change-event-

...

seller-contact.json
syntaxHighlightingJSON

fachliche Felder

Daten

API Felder

technisches EventDatum 

2022-05-11T10:34:00+02:00

eventTime

Verbindlicher Kündigungstermin

2022-12-01T12:00:00+01:00
(Uhrzeit fachlich nicht relevant, aber technisch erforderlich)

ProductOrter.

expectedCompletionDate

expectedCompletionDate

Rolle 

orderManagementSupplierContact

relatedParty.role

Anrede

Frau

relatedParty.salutation (Ms)

Vorname

Lisa

relatedParty.givenName

Nachname

Bach

relatedParty.familyName

Telefonnummer

0221/789456

relatedParty/contactMedium.mediumType = "PhoneContactMedium"

relatedParty/contactMedium/characteristic.contactType = "fixed"

relatedParty/contactMedium/characteristic.phoneNumber 

Mobilfunknummer

0178/78787878

relatedParty/contactMedium.mediumType = "PhoneContactMedium"

relatedParty/contactMedium/characteristic.contactType = "mobile"

relatedParty/contactMedium/characteristic.phoneNumber 

Email-adresse

l.bach@example.net

relatedParty/contactMedium.mediumType = "EmailContactMedium"

relatedParty/contactMedium/characteristic.contactType = "email"

relatedParty/contactMedium/characteristic.emailAddress

ProductOrderStateChangeEvent: inProgress (6)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-termination-pv-3-state-change-event-in-progress.json
syntaxHighlightingJSON

fachliche Felder

Daten 

API Felder

technisches EventDatum

2022-05-20T10:40:00+02:00

eventTime

Orderstatus 

inProgress

state 

fachliches Änderungsdatum 

2022-05-20T10:40:00+02:00

stateChangeDate 

Grund der Änderung

0000

"Keine Änderung zum Auftrag"

stateChangeReason.code

stateChangeReason.description

ProductOrderStateChangeEvent: completed (7)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-termination-pv-4-state-change-event-completed.json
syntaxHighlightingJSON

fachliche Felder

Daten 

API Felder

technisches EventDatum

2022-12-16T10:45:00+01:00

eventTime

Orderstatus 

completed

state 

fachliches Änderungsdatum 

2022-12-16T10:45:00+01:00

stateChangeDate 

Grund der Änderung

0010

"Auftrag ausgeführt."

stateChangeReason.code

stateChangeReason.description

ProductOrderAttributeValueChange (setzen von terminationDate (8))

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-termination-pv-5-attribute-value-change-event-termination-date.json
syntaxHighlightingJSON

fachliche Felder

Daten

API Felder

technisches EventDatum 

2022-12-16T10:45:30+01:00

eventTime

Nutzungsdatum 

2022-12-16T10:45:00+01:00

product.terminationDate

ProductOrderStateChangeEvent: closed (9)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-termination-pv-6-state-change-event-closed.json
syntaxHighlightingJSON

fachliche Felder

Daten 

API Felder

technisches EventDatum

2022-12-16T10:46:00+01:00

eventTime

Orderstatus 

closed

state 

fachliches Änderungsdatum 

2022-12-16T10:46:00+01:00

stateChangeDate 

Grund der Änderung

0010

"Auftrag ausgeführt."

stateChangeReason.code

stateChangeReason.description