Beschreibung Einbeziehung erweitert, Einbeziehung_Type ist final.
This commit is contained in:
@@ -113,6 +113,10 @@
|
||||
|
||||
%Seite Inhaltsverzeichnis
|
||||
\pagebreak
|
||||
|
||||
\setcounter{tocdepth}{2}
|
||||
%\setcounter{secnumdepth}{2}
|
||||
|
||||
\tableofcontents
|
||||
\end{flushleft}
|
||||
\pagebreak
|
||||
@@ -237,7 +241,7 @@
|
||||
und es \textit{muss} ein SOAP-Fault geworfen werden, falls ein AuthFilter-Element übermittelt wird, es aber fachlich nicht passt,
|
||||
beispielsweise weil der User für den Vermittler nicht berechtigt ist.\\
|
||||
|
||||
Es wird geprüft ob eine Vertragssparte übermittelt wurde. Falls keine Vertragssparte erwartet wird aber eine
|
||||
Es wird geprüft, ob eine Vertragssparte übermittelt wurde. Falls keine Vertragssparte erwartet wird aber eine
|
||||
Vertragssparte übermittelt wird oder falls eine Vertragssparte übermittelt wird, der Service aber grundsätzlich
|
||||
keine Vertragssparten unterscheidet, \textit{muss} ein SOAP-Fault geworfen werden. Falls eine Vertragssparte übermittelt
|
||||
wird, diese Sparte aber vom Service nicht unterstützt wird, \textit{muss} ein SOAP-Fault geworfen werden.
|
||||
@@ -292,4 +296,271 @@
|
||||
\bottomrule
|
||||
\end{tabularx}
|
||||
|
||||
|
||||
|
||||
\section{Methode AmendRiskProposal}
|
||||
|
||||
\subsection{Fachliche Beschreibung}
|
||||
Der Service \glqq AmendRiskProposal\grqq{} liefert für einen gegebenen Vertrag und ein gegebenes Risikoobjekt einen
|
||||
Vorschlag oder mehrere Vorschläge für die Einbeziehung. Wenn VU-spezifische Objekte für die Zusatzangaben zur
|
||||
Einbeziehung verwendet werden, so kann der Client an dem Vorschlag ablesen, welches Objekt für diese Einbeziehung
|
||||
zu verwenden ist. Werden generische Objekte für die Angaben zu dieser Einbeziehung verwendet oder ein Deep-Link,
|
||||
so kann dies ebenfalls am Response dieses Service abgelesen werden.
|
||||
|
||||
\subsubsection{Status}
|
||||
Entwurf (0)
|
||||
|
||||
\subsubsection{Vorbedingung}
|
||||
Der Benutzer existiert und kann über die Daten im SOAP-Header authentifiziert werden.
|
||||
|
||||
\subsubsection{Ablauf}
|
||||
Der Benutzer spezifiziert den Vertrag und das Risikoobjekt für die Einbeziehung. Daraufhin gibt der Service
|
||||
einen oder mehrere Vorschläge für die Durchführung der Einbeziehung zurück. Insbesondere kann aus diesen
|
||||
Vorschlägen abgelesen werden, welche Angaben für die Einbeziehung erforderlich sind und wie sie übermittelt
|
||||
werden sollen.
|
||||
|
||||
\subsubsection{Prüflogik}
|
||||
Es wird geprüft, ob eine Authentifizierung des Benutzers über die Daten im SOAP-Header möglich ist.\\
|
||||
|
||||
Weiters wird geprüft, ob die angegebene VUNr vom Service unterstützt wird. Falls die VUNr falsch ist, wird
|
||||
ein SOAP-Fault geworfen.\\
|
||||
|
||||
Es wird geprüft, ob im Request ein AuthFilter-Element vorhanden ist, welches den Vermittler näher spezifiziert. Es \textit{kann} ein
|
||||
SOAP-Fault geworfen werden, wenn ein AuthFilter-Element übermittelt wird, obwohl ein solches nicht erwartet wird. Es
|
||||
\textit{muss} ein SOAP-Fault geworfen werden, wenn kein AuthFilter-Element übermittelt wird, obwohl ein solches benötigt wird.
|
||||
und es \textit{muss} ein SOAP-Fault geworfen werden, falls ein AuthFilter-Element übermittelt wird, es aber fachlich nicht passt,
|
||||
beispielsweise weil der User für den Vermittler nicht berechtigt ist.\\
|
||||
|
||||
\subsection{Technische Dokumentation}
|
||||
|
||||
\subsubsection{ServiceID}
|
||||
|
||||
Die ServiceID dieser Methode ist \glqq AmendRiskProposal\grqq{}.
|
||||
|
||||
\subsubsection{Request}
|
||||
|
||||
\includegraphics[width=9cm]{../../../docGen/omds3_ON3_Vertrag_p19}
|
||||
|
||||
\noindent Wobei
|
||||
\begin{itemize}
|
||||
\item AuthFilter \textemdash~falls für die Einbeziehung fachlich die Angabe eines Vermittlers benötigt wird
|
||||
und dieser sich nicht aus dem User ableiten lässt, kann hier eine Vermittlernummer oder eine MaklerID
|
||||
übermittelt werden. Es ist vom Serviceprovider vorher festzulegen, ob eine solche Angabe erforderlich ist.
|
||||
\item Vertrag \textemdash~die Vorgabe eines Vertrags als Polizzennr. oder VertragsID.
|
||||
\item Risikoobjektparte \textemdash~die Vorgabe eines Risikoobjekts vom Typ\\ \texttt{cst:VersichertesInteresse\_Type}.
|
||||
\end{itemize}
|
||||
|
||||
\subsubsection{Response}
|
||||
|
||||
Der Response enthält 1…n Vorschläge, mit welchen Angaben die Einbeziehung durchgeführt werden kann.\\
|
||||
|
||||
\includegraphics[width=9cm]{../../../docGen/omds3_ON3_Vertrag_p23}
|
||||
|
||||
\noindent Wobei der einzelne Vorschlag vom Typ \texttt{Einbeziehung\_Type} ist.
|
||||
|
||||
\includegraphics[width=9cm]{../../../docGen/omds3_ON3_Vertrag_p24}
|
||||
|
||||
\begin{itemize}
|
||||
\item Vertrag \textemdash~die Polizzennummer oder VertragsID des Vertrags, in welchen einbezogen werden soll.
|
||||
\item Risikoobjekt \textemdash~die Daten zum Risikoobjekt als \texttt{cst:VersichertesInteresse\_Type}, welches einbezogen werden soll.
|
||||
\item Angaben \textemdash~optional weitere Angaben zur Einbeziehung als \texttt{AngabenEinbeziehung\_Type}.
|
||||
Dies können beispielsweise Angaben zur Zahlweise oder Fragen zur Deckung sein.
|
||||
\end{itemize}
|
||||
|
||||
\subsubsection{Fehler}
|
||||
Folgende Fehler werden über das Fault-Element des Webservice geworfen:
|
||||
|
||||
|
||||
\begin{tabularx}{\textwidth}{lp{2cm}p{3.5cm}p{6cm}}
|
||||
\toprule
|
||||
{\textbf{Fehlertyp}}&{\textbf{Fehlercode}}&{\textbf{Meldung}}&{\textbf{Warum}}\\
|
||||
\midrule
|
||||
{Fehler}&{40040}&{VUNr nicht unterstützt}&{Die angegebene VUNr wird von diesem Service nicht unterstützt.}\\
|
||||
{Fehler}&{40040}&{AuthFilter-Element benötigt}&{Nähere Angaben zum Vermittler werden benötigt, sind aber nicht vorhanden.}\\
|
||||
{Fehler}&{40040}&{AuthFilter-Element ungültig}&{AuthFilter-Element wurde übermittelt, kann aber nicht verarbeitet werden.}\\
|
||||
{Fehler}&{40040}&{Unerwartetes AuthFilter-Element}&{AuthFilter-Element wurde übermittelt, es wird aber kein AuthFilter-Element erwartet.}\\
|
||||
{Fehler}&{40040}&{Vertrag ungültig}&{Die Spezifikation für den Vertrag kann nicht verarbeitet werden, z.B. weil der Vertrag nicht existiert oder der Client nicht auf den Vertrag berechtigt ist.}\\
|
||||
{Fehler}&{40040}&{Risikoobjekt ungültig}&{Die Spezifikation für das Risikoobjekt kann nicht verarbeitet werden, z.B. weil die Angaben widersprüchlich sind oder ein entsprechendes Risikoobjekt nicht auffindbar ist.}\\
|
||||
\bottomrule
|
||||
\end{tabularx}
|
||||
|
||||
|
||||
\section{Methode AmendRiskCheck}
|
||||
|
||||
\subsection{Fachliche Beschreibung}
|
||||
Der Service \glqq AmendRiskCheck\grqq{} prüft die Angaben zu einer Einbeziehung auf Gültigkeit ohne die Einbeziehung
|
||||
jemals durchzuführen. Wenn der Aufruf grob fehlerhaft ist, erhält der Aufrufer eine SOAP-Exception zurück. Wenn der
|
||||
Aufruf nur teilweise Fehlerhaft ist, besteht die Möglichkeit einen mit Meldungen dekorierten Response zurückzugeben.
|
||||
|
||||
\subsubsection{Status}
|
||||
Entwurf (0)
|
||||
|
||||
\subsubsection{Vorbedingung}
|
||||
Der Benutzer existiert und kann über die Daten im SOAP-Header authentifiziert werden.
|
||||
|
||||
\subsubsection{Ablauf}
|
||||
Der Consumer übermittelt die Daten für eine Einbeziehung (Vertrag, Risikoobjekt und etwaige weitere Angaben).
|
||||
Der Serviceprovider prüft diese Daten und antwortet mit einer Bestätigung, dass die Einbeziehung so machbar ist,
|
||||
mit Hinweisen, welche weiteren Angaben oder Korrekturen der Einbeziehung notwendig sind oder einer Fehlermeldung als
|
||||
SOAP-Fault. Der Consumer kann die Daten für die Einbeziehung so wiederholt modifizieren und prüfen, ohne dass je
|
||||
eine tatsächliche Einbeziehung erfolgt.
|
||||
|
||||
\subsubsection{Prüflogik}
|
||||
Es wird geprüft, ob eine Authentifizierung des Benutzers über die Daten im SOAP-Header möglich ist.\\
|
||||
|
||||
Weiters wird geprüft, ob die angegebene VUNr vom Service unterstützt wird. Falls die VUNr falsch ist, wird
|
||||
ein SOAP-Fault geworfen.\\
|
||||
|
||||
Es wird geprüft, ob im Request ein AuthFilter-Element vorhanden ist, welches den Vermittler näher spezifiziert. Es \textit{kann} ein
|
||||
SOAP-Fault geworfen werden, wenn ein AuthFilter-Element übermittelt wird, obwohl ein solches nicht erwartet wird. Es
|
||||
\textit{muss} ein SOAP-Fault geworfen werden, wenn kein AuthFilter-Element übermittelt wird, obwohl ein solches benötigt wird.
|
||||
und es \textit{muss} ein SOAP-Fault geworfen werden, falls ein AuthFilter-Element übermittelt wird, es aber fachlich nicht passt,
|
||||
beispielsweise weil der User für den Vermittler nicht berechtigt ist.\\
|
||||
|
||||
Es wird geprüft, ob der Vertrag in der übermittelten Einbeziehung existiert und ob der User bei diesem eine Einbeziehung
|
||||
durchführen darf. Ist dies nicht der Fall \textit{muss} ein SOAP-Fault geworfen werden.
|
||||
|
||||
Es wird geprüft, ob die Daten zum Risikoobjekt ausreichend sind und verarbeitet werden können. Können die Angaben zum
|
||||
Risikoobjekt nicht verarbeitet werden, \textit{muss} ein SOAP-Fault geworfen werden.
|
||||
|
||||
Wenn weitere Angaben zur Einbeziehung übermittelt werden, so werden diese auf Gültigkeit geprüft. Scheitert die
|
||||
prüfung \textit{kann} ein SOAP-Fault geworfen werden oder ein Response mit (Fehler-)Meldungen zurückgeben werden.
|
||||
|
||||
\subsection{Technische Dokumentation}
|
||||
|
||||
\subsubsection{ServiceID}
|
||||
|
||||
Die ServiceID dieser Methode ist \glqq AmendRiskCheck\grqq{}.
|
||||
|
||||
\subsubsection{Request}
|
||||
|
||||
\includegraphics[width=9cm]{../../../docGen/omds3_ON3_Vertrag_p7}
|
||||
|
||||
\noindent Wobei
|
||||
\begin{itemize}
|
||||
\item AuthFilter \textemdash~falls für die Einbeziehung fachlich die Angabe eines Vermittlers benötigt wird
|
||||
und dieser sich nicht aus dem User ableiten lässt, kann hier eine Vermittlernummer oder eine MaklerID
|
||||
übermittelt werden. Es ist vom Serviceprovider vorher festzulegen, ob eine solche Angabe erforderlich ist.
|
||||
\item Einbeziehung \textemdash~die Einbeziehung, die geprüft werden soll als \texttt{Einbeziehung\_Type}.
|
||||
\end{itemize}
|
||||
|
||||
\subsubsection{Response}
|
||||
|
||||
Der Response enthält
|
||||
\begin{itemize}
|
||||
\item Status \textemdash~der Status OK, wenn die Angaben für die Einbeziehung stimmen und eine Einbeziehung in der
|
||||
übermittelten Form möglich ist. den Status NOK, wenn die Angaben für die Einbeziehung in der übermittelten Form
|
||||
in Ordnung sind und eine Einbeziehung so nicht möglich wäre. Unabhängig ob der Status OK oder NOK ist, kann der
|
||||
Response Meldungs-Objekte mit Hinweisen enthalten, welche Änderungen an den Daten der Einbeziehung gemacht werden sollten.
|
||||
\item Einbeziehung \textemdash~die unveränderte oder mit Hinweisen ergänzte Einbeziehung aus dem Request.
|
||||
\end{itemize}
|
||||
|
||||
\includegraphics[width=9cm]{../../../docGen/omds3_ON3_Vertrag_p10}
|
||||
|
||||
\subsubsection{Fehler}
|
||||
Folgende Fehler werden über das Fault-Element des Webservice geworfen:
|
||||
|
||||
\begin{tabularx}{\textwidth}{lp{2cm}p{3.5cm}p{6cm}}
|
||||
\toprule
|
||||
{\textbf{Fehlertyp}}&{\textbf{Fehlercode}}&{\textbf{Meldung}}&{\textbf{Warum}}\\
|
||||
\midrule
|
||||
{Fehler}&{40040}&{VUNr nicht unterstützt}&{Die angegebene VUNr wird von diesem Service nicht unterstützt.}\\
|
||||
{Fehler}&{40040}&{AuthFilter-Element benötigt}&{Nähere Angaben zum Vermittler werden benötigt, sind aber nicht vorhanden.}\\
|
||||
{Fehler}&{40040}&{AuthFilter-Element ungültig}&{AuthFilter-Element wurde übermittelt, kann aber nicht verarbeitet werden.}\\
|
||||
{Fehler}&{40040}&{Unerwartetes AuthFilter-Element}&{AuthFilter-Element wurde übermittelt, es wird aber kein AuthFilter-Element erwartet.}\\
|
||||
{Fehler}&{40040}&{Vertrag ungültig}&{Die Spezifikation für den Vertrag kann nicht verarbeitet werden, z.B. weil der Vertrag nicht existiert oder der Client nicht auf den Vertrag berechtigt ist.}\\
|
||||
{Fehler}&{40040}&{Risikoobjekt ungültig}&{Die Spezifikation für das Risikoobjekt kann nicht verarbeitet werden, z.B. weil die Angaben widersprüchlich sind oder ein entsprechendes Risikoobjekt nicht auffindbar ist.}\\
|
||||
{Fehler}&{40040}&{Angaben zur Einbeziehung ungültig}&{Die zusätzlichen Angaben zur Einbeziehung sind ungültig und es kann kein Vorschlag für eine gültige Form unterbreitet werden.}\\
|
||||
\bottomrule
|
||||
\end{tabularx}
|
||||
|
||||
|
||||
|
||||
\section{Methode AmendRiskSubmit}
|
||||
|
||||
\subsection{Fachliche Beschreibung}
|
||||
Der Service \glqq AmendRiskSubmit\grqq{} führt die Einbeziehung durch.
|
||||
Wenn der Aufruf in irgend einer Weise fehlerhaft ist, erhält der Aufrufer eine SOAP-Exception zurück.
|
||||
|
||||
\subsubsection{Status}
|
||||
Entwurf (0)
|
||||
|
||||
\subsubsection{Vorbedingung}
|
||||
Der Benutzer existiert und kann über die Daten im SOAP-Header authentifiziert werden.
|
||||
|
||||
\subsubsection{Ablauf}
|
||||
Der Consumer übermittelt die Daten für eine Einbeziehung (Vertrag, Risikoobjekt und etwaige weitere Angaben).
|
||||
Der Serviceprovider prüft diese Daten und antwortet mit einer Bestätigung, dass die Einbeziehung durchgeführt
|
||||
wurde oder entgegengenommen wurde.
|
||||
|
||||
\subsubsection{Prüflogik}
|
||||
Es wird geprüft, ob eine Authentifizierung des Benutzers über die Daten im SOAP-Header möglich ist.\\
|
||||
|
||||
Weiters wird geprüft, ob die angegebene VUNr vom Service unterstützt wird. Falls die VUNr falsch ist, wird
|
||||
ein SOAP-Fault geworfen.\\
|
||||
|
||||
Es wird geprüft, ob im Request ein AuthFilter-Element vorhanden ist, welches den Vermittler näher spezifiziert. Es \textit{kann} ein
|
||||
SOAP-Fault geworfen werden, wenn ein AuthFilter-Element übermittelt wird, obwohl ein solches nicht erwartet wird. Es
|
||||
\textit{muss} ein SOAP-Fault geworfen werden, wenn kein AuthFilter-Element übermittelt wird, obwohl ein solches benötigt wird.
|
||||
und es \textit{muss} ein SOAP-Fault geworfen werden, falls ein AuthFilter-Element übermittelt wird, es aber fachlich nicht passt,
|
||||
beispielsweise weil der User für den Vermittler nicht berechtigt ist.\\
|
||||
|
||||
Es wird geprüft, ob der Vertrag in der übermittelten Einbeziehung existiert und ob der User bei diesem eine Einbeziehung
|
||||
durchführen darf. Ist dies nicht der Fall \textit{muss} ein SOAP-Fault geworfen werden.
|
||||
|
||||
Es wird geprüft, ob die Daten zum Risikoobjekt ausreichend sind und verarbeitet werden können. Können die Angaben zum
|
||||
Risikoobjekt nicht verarbeitet werden, \textit{muss} ein SOAP-Fault geworfen werden.
|
||||
|
||||
Wenn weitere Angaben zur Einbeziehung übermittelt werden, so werden diese auf Gültigkeit geprüft. Scheitert die
|
||||
Prüfung \textit{muss} ein SOAP-Fault geworfen werden.
|
||||
|
||||
\subsection{Technische Dokumentation}
|
||||
|
||||
\subsubsection{ServiceID}
|
||||
|
||||
Die ServiceID dieser Methode ist \glqq AmendRiskSubmit\grqq{}.
|
||||
|
||||
\subsubsection{Request}
|
||||
|
||||
\includegraphics[width=9cm]{../../../docGen/omds3_ON3_Vertrag_p25}
|
||||
|
||||
\noindent Wobei
|
||||
\begin{itemize}
|
||||
\item AuthFilter \textemdash~falls für die Einbeziehung fachlich die Angabe eines Vermittlers benötigt wird
|
||||
und dieser sich nicht aus dem User ableiten lässt, kann hier eine Vermittlernummer oder eine MaklerID
|
||||
übermittelt werden. Es ist vom Serviceprovider vorher festzulegen, ob eine solche Angabe erforderlich ist.
|
||||
\item Einbeziehung \textemdash~die Einbeziehung, die geprüft werden soll als \texttt{Einbeziehung\_Type}.
|
||||
\end{itemize}
|
||||
|
||||
\subsubsection{Response}
|
||||
|
||||
Der Response enthält
|
||||
\begin{itemize}
|
||||
\item Status \textemdash~der Status OK, wenn die Angaben für die Einbeziehung stimmen und eine Einbeziehung in der
|
||||
übermittelten Form möglich ist. den Status NOK, wenn die Angaben für die Einbeziehung in der übermittelten Form
|
||||
in Ordnung sind und eine Einbeziehung so nicht möglich wäre. Unabhängig ob der Status OK oder NOK ist, kann der
|
||||
Response Meldungs-Objekte mit Hinweisen enthalten, welche Änderungen an den Daten der Einbeziehung gemacht werden sollten.
|
||||
\item Einbeziehung \textemdash~die unveränderte oder mit Hinweisen ergänzte Einbeziehung aus dem Request.
|
||||
\end{itemize}
|
||||
|
||||
\includegraphics[width=9cm]{../../../docGen/omds3_ON3_Vertrag_p28}
|
||||
|
||||
\subsubsection{Fehler}
|
||||
Folgende Fehler werden über das Fault-Element des Webservice geworfen:
|
||||
|
||||
\begin{tabularx}{\textwidth}{lp{2cm}p{3.5cm}p{6cm}}
|
||||
\toprule
|
||||
{\textbf{Fehlertyp}}&{\textbf{Fehlercode}}&{\textbf{Meldung}}&{\textbf{Warum}}\\
|
||||
\midrule
|
||||
{Fehler}&{40040}&{VUNr nicht unterstützt}&{Die angegebene VUNr wird von diesem Service nicht unterstützt.}\\
|
||||
{Fehler}&{40040}&{AuthFilter-Element benötigt}&{Nähere Angaben zum Vermittler werden benötigt, sind aber nicht vorhanden.}\\
|
||||
{Fehler}&{40040}&{AuthFilter-Element ungültig}&{AuthFilter-Element wurde übermittelt, kann aber nicht verarbeitet werden.}\\
|
||||
{Fehler}&{40040}&{Unerwartetes AuthFilter-Element}&{AuthFilter-Element wurde übermittelt, es wird aber kein AuthFilter-Element erwartet.}\\
|
||||
{Fehler}&{40040}&{Vertrag ungültig}&{Die Spezifikation für den Vertrag kann nicht verarbeitet werden, z.B. weil der Vertrag nicht existiert oder der Client nicht auf den Vertrag berechtigt ist.}\\
|
||||
{Fehler}&{40040}&{Risikoobjekt ungültig}&{Die Spezifikation für das Risikoobjekt kann nicht verarbeitet werden, z.B. weil die Angaben widersprüchlich sind oder ein entsprechendes Risikoobjekt nicht auffindbar ist.}\\
|
||||
{Fehler}&{40040}&{Angaben zur Einbeziehung ungültig}&{Die zusätzlichen Angaben zur Einbeziehung sind ungültig und es kann kein Vorschlag für eine gültige Form unterbreitet werden.}\\
|
||||
\bottomrule
|
||||
\end{tabularx}
|
||||
|
||||
|
||||
\end{document}
|
||||
Reference in New Issue
Block a user