Versionen im Vergleich

Schlüssel

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

...

TitelZusatzinfo melden oder aktualisieren
Kurzbeschreibung

Folgender Ablauf beschreibt die typischen Interaktionen zwischen Auftrageber und Leistungserbringer im Anwendungsfall "Zusatzinfo melden oder aktualisieren". Die Zusatzinfo ist entweder ein Montagehinweis oder ein Ansprechpartner.

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

Hinweis:

Die Taskresource wird syntaktisch synchron validiert: Pflichtparameter gesetzt etc. (Folge-Zustand Achnowledged)

Danach wurde sie fachlich validiert: PO existiert und im richtigen Zustand (Folge-Zustand InProgress)

Schließlich erfolgt die Aktualisierung der Product Order (Folge-Zustand done)

Vorbedingung

Die dazugehörige Product Order muss existieren und kaufmännisch validiert sein, so dass sich der Auftrag mindestens im Status  accepted befindet. (nicht abgebrochen oder beendet)

Darüber hinaus darf sich die dazugehörige Product Order nicht in den Zuständen Closed oder Completed befinden.

Mindestens alle Pflichtfelder für die Meldung eines Montagehinweises sind laut Auftragsmedestruktur Auftrags-/Meldungsstruktur (download) gefüllt.

AuslöserAuftraggeber möchte dem Leistungserbringer einen Montagehinweis oder Ansprechpartner, durch Erzeugung einer Task Resource vom Typ AddProductOrderInformation, übermitteln bzw aktualisieren.
Ergebnis

Der Montagehinweis oder Ansprechpartner wurde im Auftag erfolgreich gespeichert.


...

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/add-product-order-information-0-create.json
syntaxHighlightingJSON
Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/add-product-order-information-1.json
syntaxHighlightingJSON

AddProdu
fachliche FelderDatenAPI Felder
technisches EventDatum 2024-10-24T10:32:00eventTime
zu erweiternde Order388a4963-f168-4603-99e8-477200099d91productOrder.id

Montagehinweis

Montagehinweis"zweimal klingeln"

note.text = "zweimal klingeln"

note.@type = "InstallationInstruction"

Installationskontakt Endkunde
RolleinstallationContactrelatedParty.role
TypIndividualrelatedParty/partyOrPartyRole.@type
AnredeHerrrelatedParty/partyOrPartyRole.salutation
VornameAlexanderrelatedParty/partyOrPartyRole.givenName
NachnameFischerrelatedParty/partyOrPartyRole.familyName
Telefonnummer+49221145155

relatedParty/partyOrPartyRole.contactMedium.@type="PhoneContactMedium"

relatedParty/partyOrPartyRolec.ontactMedium.contactType="fixed"

relatedParty/partyOrPartyRole.contactMedium.phoneNumber="+49221145155"

Mobilfunknummer+4917878878788

relatedParty/partyOrPartyRole.contactMedium.@type="PhoneContactMedium"

relatedParty/partyOrPartyRolec.ontactMedium.contactType="mobile"

relatedParty/partyOrPartyRole.contactMedium.phoneNumber="+4917878878788"

Email-adresseAdressea.fischer@example.net

relatedParty/partyOrPartyRole.contactMedium.@type="EmailContactMedium"

relatedParty/partyOrPartyRolec.ontactMedium.contactType="email"

relatedParty/partyOrPartyRole.contactMedium.emailAddress="a.fischer@examplefischer@example.net"

Response (2)

Bitbucket file macro
collapsibletrue
url

...

https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/add-product-order-information-1.json
syntaxHighlightingJSON

AddProductOrderInformationStateChangeEvent: inProgress (3)

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

...

ProductOrderAttributeValueChange (setzen Montagehinweis oder Ansprechpartner) (4)

Analog:

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-2b-attribute-value-change-event-installation-instruction.json
syntaxHighlightingJSON
Bitbucket file macro
collapsible
true
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-2-attribute-value-change-event-supplier-contactjson
syntaxHighlightingJSON

ProductOrderAttributeValueChange 
fachliche FelderDatenAPI Felder
technisches EventDatum 2024-10-24T10:32:00eventTime

Montagehinweis

Montagehinweis"zweimal klingeln"

note.text = "zweimal klingeln"

note.@type = "InstallationInstruction"

Installationskontakt Endkunde
RolleinstallationContactrelatedParty.role
TypIndividualrelatedParty/partyOrPartyRole.@type
AnredeHerrrelatedParty/partyOrPartyRole.salutation
VornameAlexanderrelatedParty/partyOrPartyRole.givenName
NachnameFischerrelatedParty/partyOrPartyRole.familyName
Telefonnummer+49221145155

relatedParty/partyOrPartyRole.contactMedium.@type="PhoneContactMedium"

relatedParty/partyOrPartyRolec.ontactMedium.contactType="fixed"

relatedParty/partyOrPartyRole.contactMedium.phoneNumber="+49221145155"

Mobilfunknummer+4917878878788

relatedParty/partyOrPartyRole.contactMedium.@type="PhoneContactMedium"

relatedParty/partyOrPartyRolec.ontactMedium.contactType="mobile"

relatedParty/partyOrPartyRole.contactMedium.phoneNumber="+4917878878788"

Email-adresseAdressea.fischer@example.net

relatedParty/partyOrPartyRole.contactMedium.@type="EmailContactMedium"

relatedParty/partyOrPartyRolec.ontactMedium.contactType="email"

relatedParty/partyOrPartyRole.contactMedium.emailAddress="a.fischer@examplefischer@example.net"

AddProductOrderInformationStateChangeEvent

...

: done

...

(5)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/add-product-order-information-4a-state-change-event-done.json
syntaxHighlightingJSON

...

AddProductOrderInformation abgelehnt

AddProductOrderInformationStateChangeEvent

...

: rejected

...

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/add-product-order-information-4b-state-change-event-rejected.json
syntaxHighlightingJSON