Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen gezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
webservice:vermittler:vertragsverwaltung [2018/01/10 15:09]
admin [setVertrag]
webservice:vermittler:vertragsverwaltung [2019/12/09 14:11] (aktuell)
admin [addVertragskuendigung]
Zeile 2: Zeile 2:
 ===== Funktionen ===== ===== Funktionen =====
 ^Name^HTTP^Eingabe^Ausgabe^ ^Name^HTTP^Eingabe^Ausgabe^
-|[[#​addvertrag|addVertrag]]|POST ${pfad}/​{$vmt}/​kunden/​{Kunde-Id}/​vertraege|[[webservice:​vermittler#​mime-types|JSON]] [[#​vertrag|Vertrag]]|[[webservice:​vermittler#​mime-types|JSON]] Vertrag|+|[[#​addvertrag|addVertrag]]|POST ${pfad}/​{$vmt}/​kunden/​{Kunde-Id}/​vertraege|[[webservice:​vermittler#​mime-types|JSON]] [[#​vertrag|Vertrag]]|[[webservice:​vermittler#​mime-types|JSON]] ​[[#vertrag|Vertrag]]|
 |[[#​getvertraege|getVertraege]]|GET ${pfad}/​{$vmt}/​kunden/​${Kunde-Id}/​vertraege| |[[webservice:​vermittler#​mime-types|JSON]] ArrayOf [[#​vertrag|Vertrag]]| |[[#​getvertraege|getVertraege]]|GET ${pfad}/​{$vmt}/​kunden/​${Kunde-Id}/​vertraege| |[[webservice:​vermittler#​mime-types|JSON]] ArrayOf [[#​vertrag|Vertrag]]|
 |[[#​getvertrag|getVertrag]]|GET ${pfad}/​{$vmt}/​kunden/​${Kunde-Id}/​vertraege/​${Vertrag-Id}| |[[webservice:​vermittler#​mime-types|JSON]] [[#​vertrag|Vertrag]]| |[[#​getvertrag|getVertrag]]|GET ${pfad}/​{$vmt}/​kunden/​${Kunde-Id}/​vertraege/​${Vertrag-Id}| |[[webservice:​vermittler#​mime-types|JSON]] [[#​vertrag|Vertrag]]|
Zeile 9: Zeile 9:
 |[[#​getvertragsdokumente|getVertragsdokumente]]|GET ${pfad}/​{$vmt}/​kunden/​${Kunde-Id}/​vertraege/​${Vertrag-Id}/​dokumente| |[[webservice:​vermittler#​mime-types|JSON]] ArrayOf [[webservice:​vermittler:​archivierung#​archiveintrag|Archiveintrag]]| |[[#​getvertragsdokumente|getVertragsdokumente]]|GET ${pfad}/​{$vmt}/​kunden/​${Kunde-Id}/​vertraege/​${Vertrag-Id}/​dokumente| |[[webservice:​vermittler#​mime-types|JSON]] ArrayOf [[webservice:​vermittler:​archivierung#​archiveintrag|Archiveintrag]]|
 |[[#​searchvertraege|searchVertraege]]|GET ${pfad}/​{$vmt}/​vertraege/​_suche|[[webservice:​vermittler#​mime-types|JSON]] [[#​vertragssuche|Vertragssuche]]|[[webservice:​vermittler#​mime-types|JSON]] ArrayOf [[#​vertrag|Vertrag]]| |[[#​searchvertraege|searchVertraege]]|GET ${pfad}/​{$vmt}/​vertraege/​_suche|[[webservice:​vermittler#​mime-types|JSON]] [[#​vertragssuche|Vertragssuche]]|[[webservice:​vermittler#​mime-types|JSON]] ArrayOf [[#​vertrag|Vertrag]]|
 +|[[#​addVertragskuendigung|addVertragskuendigung]]|POST ${pfad}/​{$vmt}/​kunden/​{Kunde-Id}/​vertraege/​${Vertrag-Id}/​kuendigung|[[webservice:​vermittler#​mime-types|JSON]] PartOf [[#​kuendigung|Kuendigung]]|[[webservice:​vermittler#​mime-types|JSON]] PartOf [[#​kuendigung|Kuendigung]] | 
 +|[[#​setVertragVorversicherung|setVertragVorversicherung]]|PUT ${pfad}/​{$vmt}/​kunden/​${Kunde-Id}/​vertraege/​${Vertrag-Id}/​vorversicherung| [[webservice:​vermittler#​mime-types|JSON]] PartOf [[#​vorversicherung|Vorversicherung]] |[[webservice:​vermittler#​mime-types|JSON]] PartOf [[#​vorversicherung|Vorversicherung]]| 
 +|[[#​getVertragVorversicherung|getVertragVorversicherung]]|GET ${pfad}/​{$vmt}/​kunden/​${Kunde-Id}/​vertraege/​${Vertrag-Id}/​vorversicherung| |[[webservice:​vermittler#​mime-types|JSON]] PartOf [[#​vorversicherung|Vorversicherung]] |
 ==== Detaildaten ==== ==== Detaildaten ====
 ☛ [[webservice:​vermittler:​vertragsverwaltung:​detaildaten#​funktionen|VermittlerWebservice - Vertragsverwaltung - Detaildaten]] ☛ [[webservice:​vermittler:​vertragsverwaltung:​detaildaten#​funktionen|VermittlerWebservice - Vertragsverwaltung - Detaildaten]]
Zeile 170: Zeile 172:
 ==== getVertragsDokumente ==== ==== getVertragsDokumente ====
 Gibt alle dem Kunden und Vertrag zugeordnete,​ nicht ausgeblendete [[webservice:​vermittler:​archivierung#​archiveintrag|Archiveinträge]] vom Typ "​dokument"​ und vorhandener Datei zurück. Gibt alle dem Kunden und Vertrag zugeordnete,​ nicht ausgeblendete [[webservice:​vermittler:​archivierung#​archiveintrag|Archiveinträge]] vom Typ "​dokument"​ und vorhandener Datei zurück.
 +
 +
 +==== addVertragskuendigung ====
 +Legt eine Küendigung zum Vertrag an.
 +
 +=== Beispiele ===
 +== Request (formatiert) ==
 +<​code>​
 +POST ${pfad}/​{$vmt}/​kunden/​{Kunde-Id}/​vertraege/​${Vertrag-Id}/​kuendigung HTTP/1.1
 +Host: www.maklerinfo.biz
 +${Auth}
 +Content-Type:​ application/​json
 +Content-Length:​ 278
 +Connection: close
 +
 +{
 +      "​Typ":​ "​naechstmoeglich",​
 +      "​Termin":"​2020-12-31"​
 +}
 +</​code>​
 +
 +== Response (formatiert) ==
 +<​code>​
 +HTTP/1.1 200 OK
 +Content-Type:​ application/​json
 +Transfer-Encoding:​ chunked
 +Connection: close
 +
 +{
 +       "​Id":​ "​EB8DC7F5E713E604CC89"​
 +}
 +</​code>​
 +
 +
 +==== setVertragVorversicherung ====
 +Bearbeitung der Vertrags Vorversicherung.
 +
 +=== Beispiele ===
 +== Request (formatiert) ==
 +<​code>​
 +PUT ${pfad}/​{$vmt}/​kunden/​${Kunde-Id}/​vertraege/​${Vertrag-Id}/​vorversicherung HTTP/1.1
 +Host: www.maklerinfo.biz
 +${Auth}
 +Content-Type:​ application/​json
 +Content-Length:​ 212
 +Connection: close
 +
 +{
 +     "​Policennummer":​ "​2164651679835",​
 +     "​Gesellschaft":​ "​Tester",​
 +     "​Beginn":​ "​2019-05-01", ​
 +     "​Ablauf":​ "​2020-05-25",​
 +     "​Status":​ "​ges"​
 +}
 +</​code>​
 +
 +== Response (formatiert) ==
 +
 +<​code>​
 +
 +HTTP/1.1 200 OK
 +Connection: close
 +Content-Type:​ application/​json
 +
 +{
 +     "​Uri":​ "​https:​\/​\/​maklerinfo.dio\/​service\/​bd\/​broker\/​1.0\/​rest\/​999999\/​kunden\/​1\/​vertraege\/​176/​vorversicherung",​
 +     "​Id":​ "​176",​
 +     "​Vermittler":​ "​999999",​
 +     "​Policennummer":​ "​2164651679835",​
 +     "​Gesellschaft":​ "​Tester",​
 +     "​Beginn":​ "​2019-05-01",​
 +     "​Ablauf":​ "​2020-05-25", ​
 +     "​Status":"​Gek\u00fcndigt durch Gesellschaft"​
 +}
 +</​code>​
 +
 +==== getVertragVorversicherung ====
 +Gibt die Vorversicherung des Vertrages zurück.
 +
 ===== Datentypen ===== ===== Datentypen =====
 ==== Vertrag ==== ==== Vertrag ====
Zeile 225: Zeile 306:
 |Gesellschaft|[[webservice:​vermittler:​suche#​enumarationfilter|Enumarationfilter]]|[[webservice:​vermittler:​listen#​funktionen|getGesellschaften]]| |Gesellschaft|[[webservice:​vermittler:​suche#​enumarationfilter|Enumarationfilter]]|[[webservice:​vermittler:​listen#​funktionen|getGesellschaften]]|
 |Versicherungsscheinnummer|[[webservice:​vermittler:​suche#​volltextfilter|Volltextfilter]]| | |Versicherungsscheinnummer|[[webservice:​vermittler:​suche#​volltextfilter|Volltextfilter]]| |
 +
 +==== Kuendigung ====
 +^Name^Datentyp^Beschreibung^
 +|Id|string| |
 +|Typ|[[webservice:​vermittler#​simpletypes|EnumValue]]|[[webservice:​vermittler:​listen#​getVertragskuendigungsGruende|getVertragskuendigungsGruende]]|
 +|Termin|Date| |
 +
 +==== Vorversicherung ====
 +^Name^Datentyp^Beschreibung^
 +|Uri|[[#​simpletypes|Uri]]| |
 +|Id|string| |
 +|Vermittler|[[webservice:​vermittler:​suche#​enumarationfilter|Enumarationfilter]]|(Unter-) Vermittlernummern|
 +|Policennummer|string| |
 +|Gesellschaft|[[webservice:​vermittler:​suche#​enumarationfilter|Enumarationfilter]]|[[webservice:​vermittler:​listen#​funktionen|getGesellschaften]]|
 +|Beginn|Date| |
 +|Ablauf|Date| |
 +|Status|[[webservice:​vermittler#​simpletypes|EnumValue]]|[[webservice:​vermittler:​listen#​getVorversicherungStatus|getVorversicherungStatus]]|
 +