onlineoffer

Einführung Schnittstelle

Ermöglicht das Vervollständigen eines Antrags und die Übermittlung per E-Mail / Webservice an die Gesellschaft!
Bitte beachten Sie:Für eine korrekte Verarbeitung müssen die Schnittstellen im gleichen Sessioncontext aufgerufen werden!

Allgemeine Schnittstellen

method	description
POST getproductstatus	Liefert allgemeine Informationen für die Onlinebeantragung zum gewählten Produkt.

Verwendung der tool-spezifischen Oberflächen
Ermöglicht das Durchführen einer Onlinebeantragung unter zuhilfename der tool-spezifischen Oberflächen.

method	description
POST enter	Liefert als Ergebnis eine URL, die direkt zur Antragsvervollständigung (AVV) im Tool führt.
POST getdocuments	Gibt die erzeugten Dokumente aus der Onlinebeantragung zurück.
POST getcasestatus	Liefert die Statusinformationen zur Onlinebeantragung zurück.

Verwendung Ihrer eigenen Oberflächen
Mit den folgenden Schnittstellen haben Sie die Möglichkeit die Onlinebeantragung mithilfe Ihren eigens gestalteten Oberflächen durchzuführen. Bitte beachten Sie: Die Reihenfolge der definierten Schnittstellen beschreibt den Ablauf!

method	description
POST createcase	Erzeugt einen neuen Vorgang für die Onlinebeantragung und liefert die grundlegenden Vorgangsinformationen zurück! Vorbelegung: Für die Vorbelegung von Personen und Vertragsdaten müssen ergänzend jeweils die Objekte "personen" sowie "contractdata" übermittelt werden. Die Angaben unterscheiden sich je Scope!
POST getrequiredfields	Diese Schnittstelle liefert eine Liste von Formular-Definitionen zurück in der Daten enthalten sind, welche für die Erstellung eines vollständigen Antrages notwendig sind. Nur mithilfe eines vollständigen Antrages kann eine Onlinebeantragung durchgeführt werden. Die Menge der Angaben ist individuell und kann sich je Scope, je Gesellschaft, je Produkt unterscheiden. Wichtig: Bitte beachten Sie die für jedes Element erzeugten "event-handler". Diese sind für eine korrekte Erzeugung des Antrags notwendig da sie z.B. notwendige Sichtbarkeitssteuerungen, Vorbelegungen, Validierungen durchführen. Bei den Event-Handlern handelt es sich um Inline Javascript. Zur Ausführung der Event-Handler ist jQuery notwendig! Die Formular-Elemente müssen einer bestimmten Struktur folgend aufgebaut werden, um sowohl die korrekte Erstansicht des Formulars als auch die Funktionsweise der Event-Handler zu gewährleisten: Template Pseudocode {foreach response['formulars'] as formular} <form name="{formular['name']}"> {foreach formular.fields as field} {* Feld-Wrapper } <div data-field="{field['name']}" class="{if !field['visible']}hidden{/if}"> { Feld-Label } <label for="field['id']}"> {field['label']} {if field['required']} <sup class="required-label"></sup> {/if} </label> {* Feld } <... id="{field['id']}" name="{field['name']}" value="{field['value']\|default:$field['default']}" {if field['required']} required {/if} {if field['readonly']} readonly {/if} {if field['disabled']} disabled="disabled" {/if} {if field['maxlength']} maxlength="{field['maxlength']}" {/if} {foreach field['data'] as property => value} data-{property}="{value}" {/foreach} {field['event-handler']} > </div> {/foreach} </form> {/foreach} Darüber hinaus muss im CSS-Code der Seite die Klasse "hidden" definiert werden. Diese wird von den Event-Handlern zur Sichtbarkeitssteuerung benötigt: .hidden { display: none !important; } Hinweise:* Da es sich um einen dynamischen Prozess handelt, kann sich je nach Produkt der Umfang der zurück gelieferten Felder unterscheiden. Abhängig vom Umfang der Felder sind der Scope, die Gesellschaft das Produkt und die ggf. vorhandenen Bausteine. Diese Kombination ist in der "PKFG" abgebildet. Es werden derzeit weitere Felder als beschrieben zurück geliefert. Diese werden in zukünftigen Updates entfernt! Bitte orientieren Sie sich ausschließlich an den Feldern die in der Dokumentation beschrieben sind! Vorraussetzung für die Abfrage der notwendigen Felder ist die Erzeugung eines Vorgangs über "createCase".
POST createcontract	Erstellt einen vollständigen Antrag zum gewünschten Produkt innerhalb des Vorgangs. Außerdem werden zusätzliche Informationen zurück geliefert welche die weiteren Schritte (z.B. Unterschreiben der erzeugten Dokumte) beschreiben. Wichtig: Bitte beachten Sie, dass Sie alle Formulare und Felder, welche Sie von der Schnittstelle "getRequiredFields" erhalten haben, im Request übermitteln. Damit stellen Sie sicher, das die Angaben vollständig im erzeugten Dokument enthalten sind.
POST getdocumentstatus	Liefert den Status der Dokumente zurück.
POST submit	Übermittelt den Antrag an die Gesellschaft.