2.3 - Webschnittstelle

wiki.poe.de / poe Standardschnittstelle

Achtung! Diese Form der Schnittstelle ist nur bei Einsatz von TRADEMAN 2 in Verbindung mit Filialmanager verfügbar!

Achtung! Diese Form der Schnittstelle ist nicht für alle Satzarten fertiggestellt. Und dies auch dann, wenn die Datenbankfelder in dieser Dokumentation schon beschrieben sind. Bitte immer erst den aktuellen Fertigstellungsstand anfragen, wenn diese Form der Schnittstelle benutzt werden soll.

Die in diesem Dokument beschriebenen Satzarten können teilweise auch per JSON Format über eine Web-API ausgetauscht werden. Dazu werden in TRADEMAN 2 mehrere HTTP-Endpunkte bereitgestellt, welche Zugriff auf die oben beschriebenen import2 und export2 Tabellen in der Datenbank gewähren. Authentifizieren müssen Sie sich dabei mit http-basic-authentification.

Das von der Web-API benutzte JSON Format ist für die Nutzdaten analog zur Tabellenstruktur von import2 und export2 aufgebaut:

	Feld	Feldbedeutung	Typ	Bemerkung
1	id	ID	Integer (autoinc)	Web-API vergibt selber eine fortlaufende Nummer
2	cdate	Anlagedatum	String[14]	Im Format YYYYMMDDHHMMSS Wird durch Web-API automatisch gesetzt
3	done	Fertig	Boolean	Datensatz wurde vom Empfänger gelesen und kann gelöscht werden Wird durch FilialManager nach import gesetzt.
4	stype	Satzart	String[16]	Satzartkennzeichen z.B. « ART »
5	ctype	Änderungskennzeichen	Integer	Wie laut Satzartbeschreibung vorgesehen
6	target	Zielsystem	Integer	Immer 0 / Wird automatisch durch Web-API gesetzt.
	c1…cn	Kurztext1 – n	String[64]	Die kurzen Textfelder der Satzart, wie in der Spalte DBFELD der Satzartbeschreibung zugewiesen
	s1…sn	Text1 – n	String[255]	Die Textfelder der Satzart, wie in der Spalte DBFELD der Satzartbeschreibung zugewiesen
	t1…tn	Langtext1 – n	String	Die Langtextfelder der Satzart, wie in der Spalte DBFELD der Satzartbeschreibung zugewiesen
	b1…bn	Boolsche Felder	Boolean	Die Boolschen Felder der Satzart, wie in der Spalte DBFELD der Satzartbeschreibung zugewiesen
	i1…in	Ganzzahl Felder	Integer	Die Ganzzahl Felder der Satzart, wie in der Spalte DBFELD der Satzartbeschreibung zugewiesen
	f1…fn	Fließkomma Felder	Float	Die Fließkomma Felder der Satzart, wie in der Spalte DBFELD der Satzartbeschreibung zugewiesen
	h1…hn	Hexadezimale Felder	String[255]	Die hexadezimalen Felder der Satzart, wie in der Spalte DBFELD der Satzartbeschreibung zugewiesen
	d1…dn	Zeitfelder	String[14]	Es werden nur so viele Felder gefüllt, wie in der Satzartbeschreibung vorgegeben, also 14 oder 8 oder 6

Achtung! Aus Übersichtlichkeitsgründen, werden Felder welche in der Datenbank einen expliziten ‚NULL‘ Wert enthalten nicht übertragen. Es ist dringend empfohlen vor dem Lesen eines Felder die Existenz auf dem Objekt zu prüfen.

Vertraulichkeitshinweis
Dieses Dokument und etwaige Anlagen können vertrauliche sowie der beruflichen Schweigepflicht unterliegende Informationen enthalten. Sollten Sie dieses Dokument irrtümlich erhalten haben, benachrichtigen Sie uns bitte durch eine Antwort-Mail und löschen Sie dieses Dokument nebst Anlagen von Ihrem System. Das unerlaubte Kopieren sowie die Weitergabe sind nicht gestattet. Vielen Dank!

Confidentiality note
This document, including any attachment, may contain confidential and privileged information. If you have received it by mistake, please notify us by reply e-mail and then delete this document and any attachment from your system. Any unauthorized copying, disclosure or distribution of the material in this document is strictly forbidden. Thank you.