Skip to content

VermittlerWebservice - Archivierung

Funktionen

Name HTTP Eingabe Ausgabe
getKundenDokumente GET ${pfad}/{$vmt}/kunden/${Kunde-Id}/dokumente JSON ArrayOf Archiveintrag
getKundenArchiveintraege GET ${pfad}/{$vmt}/kunden/${Kunde-Id}/archiveintraege JSON ArrayOf Archiveintrag
addKundenArchiveintrag POST ${pfad}/{$vmt}/kunden/${Kunde-Id}/archiveintraege PDF oder TEXT
getKundenArchivToken POST ${pfad}/{$vmt}/kunden/${Kunde-Id}/generate-archive-token JSON Kundenarchivierungs-OTP
getArchiveintrag GET ${pfad}/{$vmt}/archiveintraege/${Archiveintrag-Id} Archiveintrag
deleteArchiveintrag DELETE ${pfad}/{$vmt}/archiveintraege/${Archiveintrag-Id}
getArchivDatei GET ${pfad}/{$vmt}/archiveintraege/${Archiveintrag-Id}.${Datei-Endung} Datei
getArchivText GET ${pfad}/{$vmt}/archiveintraege/${Archiveintrag-Id}/text.txt TEXT

getKundenArchivToken

Als HTTP-Body kann ein JSON-Objekt "Contracts" bestehend aus einem Array mit Vertrag-Ids übergeben werden, um das Archivierungs-Token auf die angegebenen Verträge des Kunden zu begrenzen.
Wenn kein gültiger HTTP-Body gesetzt wurde, ist das OTP für alle Verträge des Kunden gültig.

Beispiel

POST ${pfad}/{$vmt}/kunden/${Kunde-Id}/generate-archive-token HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json

{"Contracts":[...]}

addKundenArchiveintrag

Folgende Header können mit Angegeben werden

☛ Zurodnungen vom Zuordnungstyp "kunde" werden ignoriert da sich diese aus der Url ergibt

Name Typ Beschreibung
Typ EnumValue Typ
Betreff string
Zuordnungen JSON ArrayOf Zuordnung
Datum DateTime standard: aktueller Zeitpunkt
Tags JSON ArrayOf string
Metadaten JSON ArrayOf Metadata

Als HTTP-Body wird bei Dokument das PDF hinzugefügt, sonst der Text.

Beispiel Dokument

Das Dokument wird mit dem Vertrag ${Vertrag-Id} und der Sparte ${Sparte-Id} verknüpft. Zusätzlich wird es unter anderem als Maklervollmacht gekennzeichnet
☛ Im Falle das name im Content-Type Header gesetzt ist, kann der Betreff weggelassen werden

POST ${pfad}/{$vmt}/kunden/${Kunde-Id}/archiveintraege HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
X-Dio-Zuordnungen: [{"Typ":"vertrag","Id":"${Vertrag-Id}"},{"Typ":"sparte","Id":"${Sparte-Id}"}]
X-Dio-Tags: ["Maklervertrag","Lorem","Ipsum"]
X-Dio-Metadaten: [{"Value":"_kundensichtbar","Text":"1"}]
X-Dio-Typ: dokument
Content-Type: application/pdf; name="Lorem ipsum.pdf"

%PDF...

Beispiel E-Mail

POST ${pfad}/{$vmt}/kunden/${Kunde-Id}/archiveintraege HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
X-Dio-Betreff: Lorem Ipsum dolor
X-Dio-Tags: ["Lorem","Ipsum"]
X-Dio-Metadaten: [{"Value":"Bar","Text":"Foo"}]
X-Dio-Typ: email
Content-Type: text/plain; charset="utf-8"

Lorem ipsum dolor sit amet..

getKundenDokumente

Gibt alle dem Kunden zugeordnete, nicht ausgeblendete, Archiveinträge vom Typ "dokument" und vorhandener Datei zurück.

getKundenArchiveintraege

Gibt alle dem Kunden zugeordnete, nicht ausgeblendete, Archiveinträge zurück.

Datentypen

Typ

Kann folgende Werte enthalten:

Value Text
dokument Dokument
fax Fax
email E-Mail
sms SMS
telefon Telefon
brief Brief
persoenlich Persönlich
chat Chat
sonstiges Sonstiges

Autor

Name Typ Beschreibung
Typ EnumValue Autorentyp
Id string

Zuordnung

Name Typ Beschreibung
Typ EnumValue Zuordnungstyp
Id string

Metadata

Name Typ Beschreibung
Value string Archiveintrag-Zustand
Text string Archiveintrag-Zustand

Archiveintrag-Zustand

Kann folgende Werte enthalten:

Value Text
_kundensichtbar _kundensichtbar
_unbearbeitet _unbearbeitet
_ausgeblendet _ausgeblendet

Diese Werte werden nur gesetzt, wenn der Zusand des Archiveintrages vom "Standart" abweicht. Der "Standart" entspricht also: "kundenunsichtbar", "bearbeitet" und "eingeblendet". Die Metadaten sind in diesem Fall dann leer.

Zuordnungstyp

Kann folgende Werte enthalten:

Value Text
vertrag Vertrag
sparte Sparte
kunde Kunde

Autorentyp

Kann folgende Werte enthalten:

Value Text
vermittler Vermittler
mitarbeiter Mitarbeiter
kunde Kunde

Archiveintrag

Name Typ Anmerkung
Uri Uri
Id string
Typ EnumValue Typ
Datum DateTime
Betreff string
Text Uri falls vorhanden kann unter dieser Uri der Text mittels getArchivText abgeholt werden
Autor Autor
Zuordnungen ArrayOf Zuordnung
Metadaten ArrayOf Metadata weitere Metadaten
Tags ArrayOf string
Datei Uri falls vorhanden kann unter dieser Uri der Inhalt der Datei mittels getArchivDatei abgeholt werden
Anhaenge ArrayOf Anhang

Anhang

Name Typ Anmerkung
Betreff string
Datei Uri falls vorhanden kann unter dieser Uri der Inhalt der Datei mittels getArchivDatei abgeholt werden

Kundenarchivierungs-OTP

Name Typ Anmerkung
Otp string Kann für den in der Url angegebenen Kunden und seine Verträge für addKundenArchiveintrag genutzt werden (siehe: Authentifizierung#OTP)
Expires int Ablaufdatum des OTPs als unix-timestamp. Bis zu 24 Stunden nach der Generierung gültig.