MitarbeiterWebservice - Archivierung

Funktionen

Name	HTTP	Eingabe	Ausgabe
addArchiveintrag	POST ${pfad}/{$ma}/archiveintraege	PDF oder TEXT	JSON Archiveintrag
getArchiveintrag	GET ${pfad}/{$ma}/archiveintraege/${Archiveintrag-Id}		Archiveintrag
getArchivDatei	GET ${pfad}/{$ma}/archiveintraege/${Archiveintrag-Id}.${Datei-Endung}		Datei
getArchivText	GET ${pfad}/{$ma}/archiveintraege/${Archiveintrag-Id}/text.txt		TEXT

addArchiveintrag

Folgende Header können mit Angegeben werden

☛ Es MUSS genau eine Zuordnung vom Zuordnungstyp "kunde" vorhanden sein

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}/{$ma}/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}/{$ma}/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..

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

Zuordnung

Name	Typ	Beschreibung
Typ	EnumValue	Zuordnungstyp
Id	string

Metadata

Name	Typ	Beschreibung
Value	string
Text	string

Zuordnungstyp

Kann folgende Werte enthalten:

Value	Text
vertrag	Vertrag
sparte	Sparte
kunde	Kunde

Archiveintrag

Name	Typ	Anmerkung
Uri	Uri
Id	string
Typ	EnumValue	Typ
Datum	DateTime
Betreff	string
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