Versionen im Vergleich

Version Alte Version 18 Neue Version Aktuell
Änderungen wurden vorgenommen von

Former user

Stephan Braune

Gespeichert am

Schlüssel

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

...

TitelAuftrag (Kündigung durch AG) anlegen
Kurzbeschreibung

Folgender Ablauf beschreibt für den Gut-Fall die typischen API- Interaktionen zwischen Auftraggeber Auftrageber und Leistungserbringer im Anwendungsfall "Auftrag (Kündigung durch Auftraggeber/Kunde"AG) anlegen" von der Anlage des Auftrags bis zu seinem Abschluss.

Dieser Anwendungsfall behandelt die Kündigung eines Produktes durch den Auftraggeber. Die Kündigung muss sich auf ein im Bestand des jeweiligen Auftraggebers befindliches Produkt beziehen. Eine Kündigung ist nur dann möglich, wenn keine weiteren offenen Aufträge zum Bestand des Auftraggebers vorliegen. Dies gilt sowohl für Aufträge des bestandsführenden Auftraggebers als auch von anderen Auftraggebern (z.B. beim Geschäftsfall Providerwechsel). Voraussetzung für den Geschäftsfall Kündigung durch Auftraggeber ist ein bestehender Rahmenvertrag zwischen dem Auftraggeber und dem Leistungserbringer sowie die Angabe aller ausführungsrelevanten Daten. 

Entsprechung: KUE/KD in WITA, KUE/AG in SPRI

 

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

Vorbedingung
  • Rahmenvertrag ist vorhanden
  • Das zu kündigende Produkt befindet sich im Bestand des Auftraggebers
  • Es liegen keine offenen Aufträge zum
Produkt vor
  • betroffenen Bestand (z.B. für den Anschluss oder dem Übertragungsweg) vor.
  • Mindestens alle Pflichtfelder für eine Product Order im Anwendungsfall KUE-AG sind laut Auftrags-/Meldungsstruktur (download) gefüllt.
Auslöser

Der Auftraggeber legt einen Kündigungsauftrag (Geschäftsfall Kündigung) an.

Ergebnis

Das Produkt wurde gekündigt und deaktiviert.

Ablauf

...

Beispieldaten

ProductOrder (Kündigung)

src/test/examples/ftth-no-opts
Stashincludebyfilepath
repoSlugtmf622-product-order
branchIdrefs/heads/main
projectKeyTFIT
filepath
Bitbucket file macro
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/assets/UC_KUE-KD.puml
syntaxHighlightingPlantUML

Beispieldaten

POST ProductOrder Kündigung AG (1)

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

fachliche FelderDaten API FelderBemerkung
technische Daten
fachliches Bestelldatum des AG2022-05-11T10:30:00+02:00orderPostedDate
Geschäftsfall Name"terminationByBuyer"category
Produktdaten
GeschäftsfallAktiondeleteproductOrderItem.action

Identifikation des Inventars

  • Produkt Identifier

 (ODER ALTWELT)

  • Einzelvertragsnummer
  • (ODER)
  • 555001Vertragsnummer bei Telekom bzw. NGAB: LINE-ID


  • 388a4963-f168-4603-99e8-477200099d91


  • 3091231119


  • Product.id (ODER)


  • Product.singleContractId
Annahme = Identifikation des Inventars über Product.
  • id
Auftragsdaten
Kündigungswunschtermin 01.12.20222022-12-01T12:00:00+01:00
(Uhrzeit fachlich nicht relevant, aber technisch erforderlich)

ProductOrder.

requestedCompletionTimePeriod

requestedCompletionDate

Auftraggeberdaten
Leistungs-Nummer500012

Agreement.businessId (agreementType = ServiceContractBuyerServiceContract)

Auftraggeber-Nummer
500011Agreement.engagedParty.businessId
Externe Auftragsnr1000111externalIdenitifier.id 

ProductOrderStateChangeEvent:

...

Accepted (4)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-delete-1-state-change-event-acknowledgedaccepted.json
showLineNumberssyntaxHighlightingtrue
progLangplain
collapsibletrue
applicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
JSON

31technisches EventDatum32eventTime
fachliche FelderDaten API Felder
Orderstatus acknowledgedstate 
OrderstatusChangeDatetechnisches EventDatum2022-05-11T10:32:00+01:00stateChangeDate eventTime
Orderstatus acceptedstate 
OrderstatusChangeDate2022-05-11T10:31:00+01:00stateChangeDate 
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-delete-2-attribute-value-change-event-supplierseller-contact.json
showLineNumberstrue
progLangplain
collapsibletrue
applicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
syntaxHighlightingJSON

orderManagementSupplierContact
fachliche FelderDatenAPI Felder
technisches EventDatum 2022-05-11T10:32:00eventTime
Pointer auf die gemachte Änderung

/relatedParty/

/expectedCompletionTimePeriod/

fieldPath.path

fieldPath.typeOfChange = add

Verbindlicher Liefertermin01.12.2022ProductOrder.expectedCompletionTimePeriod
Rolle Verbindlicher Kündigungstermin2022-12-01T12:00:00+01:00
(Uhrzeit fachlich nicht relevant, aber technisch erforderlich)

ProductOrder.expectedCompletionDate

Auftragsmanagment
 
Rolle orderManagementSellerContactrelatedParty.role
AnredeFraurelatedParty.salutation (Ms)
VornameLisarelatedParty.givenName
NachnameBachrelatedParty.familyName
Telefonnummer0221/789456

relatedParty/contactMedium.mediumType = phone"PhoneContactMedium"

relatedParty/contactMedium/characteristic.contactType = "fixed"

relatedParty/contactMedium/characteristic.phoneNumber 

Mobilfunknummer0178/78787878

relatedParty/contactMedium.mediumType = phone "PhoneContactMedium"

relatedParty/contactMedium/characteristic.contactType = "mobile"

relatedParty/contactMedium/characteristic.phoneNumber 

Faxnummer

Email-adresseAdressel.bach@example.net

relatedParty/contactMedium.mediumType = email"EmailContactMedium"

relatedParty/contactMedium/characteristic.contactType = "email"

relatedParty/contactMedium/characteristic.emailAddress="l.bach@example.net"

ProductOrderStateChangeEvent: inProgress

...

(6)

Bitbucket file macro
cbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-delete-3-state-change-event-in-progress.json
showLineNumberstrue
progLangplain
collapsibletrue
applicationLinksyntaxHighlightingJSON

technisches EventDatumeventTime

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

0000

"Keine Änderung zum Auftrag"

fachliche FelderDaten API Felder
Orderstatus inProgressstate 
fachliches Änderungsdatum technisches EventDatum2022-05-20T10:40:00+01:00stateChangeDate eventTime
Orderstatus inProgressstate 
fachliches Änderungsdatum 2022-05-20T10:40:00+01:00stateChangeDate 
Grund der Änderung

0000

"Keine Änderung zum Auftrag"

stateChangeReason.code

stateChangeReason.description

Historisierung acknowledged

fachliches Änderungsdatum 

Grund der Änderung

stateChangeHistory.@type = StateChange

stateChangeHistory.changeDate

stateChangeHistory.changeReason.code

stateChangeHistory.changeReason.description

ProductOrderStateChangeEvent: completed

...

ProductOrderStateChangeEvent: completed (7)

Bitbucket file macro
cbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-delete-4-state-change-event-completed.json
showLineNumberstrue
progLangplain
collapsibletrue
applicationLinksyntaxHighlightingJSON

technisches EventDatumeventTime.description

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

0000

"Keine Änderung zum Auftrag"

stateChangeHistory@type = StateChange

stateChangeHistory.changeDate

stateChangeHistory.changeReason.code

stateChangeHistory.changeReason.
fachliche FelderDaten API Felder
Orderstatus completedstate 
fachliches Änderungsdatum technisches EventDatum2022-12-16T10:45:00+01:00stateChangeDate eventTime
Orderstatus completedstate 
fachliches Änderungsdatum 2022-12-16T10:45:00+01:00stateChangeDate 
Grund der Änderung

0010

"Auftrag ausgeführt."

stateChangeReason.code

stateChangeReason

Historisierung inProgress

fachliches Änderungsdatum 

Grund der Änderung

.

description

ProductOrderAttributeValueChange

...

(setzen von terminationDate)

...

(8)

Bitbucket file macro
cbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-delete-5-attribute-value-change-event-termination-date.json
showLineNumberstrue
progLangplain
collapsibletrue
applicationLinksyntaxHighlightingJSON

fachliche FelderDatenAPI Felder
technisches EventDatum 2022-12-16T10:45:30+01:00eventTime
Pointer auf die gemachte Änderung/terminationDate/

fieldPath.path

fieldPath.typeOfChange = add

Nutzungsdatum 2022-12-16T10:45:00+01:00product.terminationDate

ProductOrderStateChangeEvent:

...

closed

...

(9)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-delete-6-state-change-event-closed.json
showLineNumberssyntaxHighlightingtrue
progLangplain
collapsibletrue
applicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
JSON

fachliches Änderungsdatum technisches EventDatumeventTime.description

2022-05-20T10:45:30+01:00

0000

"Keine Änderung zum Auftrag"

stateChangeHistory.@type = StateChange

stateChangeHistory.changeDate

stateChangeHistory.changeReason.code

stateChangeHistory.changeReason
fachliche FelderDaten API Felder
Orderstatus closedstate 
technisches EventDatum2022-12-16T10:46:00+01:00stateChangeDate eventTime
Orderstatus closedstate 
fachliches Änderungsdatum 2022-12-16T10:46:00+01:00stateChangeDate 
Grund der Änderung

0010

"Auftrag ausgeführt."

stateChangeReason.code

stateChangeReason

Historisierung completed

fachliches Änderungsdatum 

Grund der Änderung

.description