Folgende Felder werden von der Schnittstelle zurückgegeben.
Bitte beachten Sie hier, dass PHP im Bezug auf Datentypen sehr nachlässig arbeitet. Das bedeutet, dass auch Datenbankfelder mit rein numerischen Definitionen dennoch als String ausgegeben werden.
| Feld | Definition | Beschreibung |
|---|---|---|
| id | int(11) | Primärschlüssel des Datensatzes |
| path | varchar(256) | Pfad unter dem die Datei auf dem Server abgelegt ist |
| user | int(11) | interne ID des Nutzers |
| trashFlag | enum('0', '1') | 1 bedeutet, dass die Datei in den Müll verschoben wurde |
| trashTimestamp | int(11) | UNIX-Timestamp wann die Datei in den Müll verschoben wurde (Vorhaltezeit 6 Wochen) |
| corruptedFlag | enum ('0', '1') | 1 bedeutet, dass die Datei als nicht verarbeitbar eingestuft wurde |
| corruptedMessage | varchar(256) | Information, warum die Datei als nicht verarbeitbar eingestuft wurde |
| corruptedTimestamp | int(11) | UNIX-Timestamp wann die Datei als nicht verarbeitbar eingestuft wurde |
| ocr | enum ('pending', 'in progress', 'success', 'fail') | Status der optischen Texterkennung |
| icr | enum ('pending', 'in progress', 'success', 'fail') | Status der inhaltlichen Textverarbeitung |
| context | enum ('interface') | 'interface' bedeutet, dass die Datei nur über Schnittstelle bearbeitet wird und in der GUI nicht zu sehen ist |
| date | date | Dokumentendatum |
| listDates | text | JSON-Array, welches weitere Datumsangaben enthalten kann - siehe Definition |
| otherValues | text | JSON-Array, welches weitere Informationen enthalten kann - siehe Definition |
| url | varchar(128) | URL des VR - z.B. 'condor-versicherungen.de' |
| urlManually | enum ('0', '1') | 1 bedeutet, dass der Nutzer die URL manuell ausgewählt hat |
| listCompanies | text | JSON-Array, welches alle gefundenen URL enthält |
| firstName | varchar(128) | Vorname des VN |
| lastName | varchar(128) | Nachname des VN |
| companyName | varchar(128) | Firmenname des VN |
| street | varchar(128) | Straße der Wohnanschrift des VN |
| town | varchar(128) | Ort der Wohnanschrift des VN |
| zipCode | varchar(16) | PLZ der Wohnanschrift des VN |
| policyNumber | varchar(256) | VSNR (formatiert) |
| damageNumber | varchar(256) | Schaden-Nummer (formatiert) |
| paymentValue | decimal(8,2) | Beitrag laut Zahlweise - siehe Definition |
| paymentFrequency | int(11) | Zahlungsrhythmus - siehe Definition |
| noClaimsBonusClass | text | JSON-Array, welches die Schadenfreiheitsklassen von KZF-Versicherungen enthalten kann - siehe Definition |
| IBAN | varchar(34) | IBAN (Feld vorbereitet, wird derzeit nich nicht benutzt) |
| licensePlateNumber | varchar(12) | KFZ-Kennzeichen |
| referenceNumber | varchar(32) | Referenz- oder Antragsnummer, falls auffindbar |
| title | varchar(256) | Dokumententitel |
| titlePossible | varchar(256) | Vorschlag für Dokumententitel, falls Übereinstimmung unzureichend |
| titleAddition | varchar(256) | vom Nutzer manuell gespeicherter Zusatz zum Titel |
| subtitle | varchar(256) | Sub-Titel |
| subtitlePossible | varchar(256) | Vorschlag für Sub-Titel, falls Übereinstimmung unzureichend |
| vuNr | varchar(16) | VU-Nummer (ID des VR bei der BaFin) |
| vuNrPossible | varchar(256) | JSON-Array, welches weitere VU-Nummern des VR enthält, falls eine eindeutige Zuordnung nicht möglich ist |
| status | int(11) | Erkennungs-Status - Mögliche Werte:
|
| priority | int(11) | Priorität - Mögliche Werte:
|
| rate | int(11) | Erkennungsrate in Prozent |
| sizeRatio | int(11) | Größenverhältnis der aktuellen Datei zur gefundenen Vorlage in Prozent (0-100) |
| wordRatio | int(11) | Verhältnis der Wortanzahl der aktuellen Datei zur gefundenen Vorlage in Prozent (0-100) |
| fileName | varchar(256) | Dateiname (ertellt aus den ermittelten Daten anhand der eingestelltn Vorgabe) |
| category | varchar(128) | beim Uplaod festgelegte Kategorie / Eingangsart des Dokumentes - z.B. 'PDF_GES', |
| marker | varchar(288) | Marker / Hash der Datei |
| usedMaster | varchar(288) | Marker / Hash der gefundenen Vorlage |
| idOCR | varchar(128) | ID der Datei im OCR-System, falls OCR gerade aktiv ist |
| idContract | int(11) | Primärschlüssel des Vertrsgdatensatzes, falls der beim Upload angeleifert wurde |
| text | text | ausgelesener Text |
| meta | longtext | JSON-Array, welches zusätzliche Daten enthalten kann - siehe Definition |
| pdfInfo | text | JSON-Array, welches eingebettete Informationen der PDF-Datei enthält |
| statusInfo | text | JSON-Array, mit chronologischen Informationen zur Verarbeitung der Datei |
| timestamp | int(11) | UNIX-Timestamp wann die Datei angelegt wurde |
| insuranceCompany | --- dynamisches Feld - nicht in der DB vorhanden | VR-Kürzel, wenn unter Einstellung Gesellschaften eine entsprechende Vorgabe gemacht wurde (Freitext) |
| fileNameRaw | --- dynamisches Feld - nicht in der DB vorhanden | Dateiname (original) |
| fileNameConvention | --- dynamisches Feld - nicht in der DB vorhanden | Template mit dem der Dateiname "fileName" generiert wurde - z.B. '(lastName)(firstName)(companyName)(policyNumber)(title)' |
| fileNameTemp | --- dynamisches Feld - nicht in der DB vorhanden | ungesicherter Dateiname, der auch Slashes enthalten kann |
| policyNumberRaw | --- dynamisches Feld - nicht in der DB vorhanden | VSNR (unformatiert) |
| damageNumberRaw | --- dynamisches Feld - nicht in der DB vorhanden | VSNR (unformatiert) |
| actionIds | --- dynamisches Feld - nicht in der DB vorhanden | JSON-Array, welches unter Einstellung Dokumententitel definierte Aktions-IDs enthalten kann |
listDates ist ein Text-Feld, welches wiederum Daten in JSON enthält. Folgende Felder können enthalten sein:
| Feld | Definition | Beschreibung |
|---|---|---|
| startDate | Datum im Format YYYY-MM-DD | Beginn der Vertragslaufzeit bzw. des Versicherungsschutzes |
| expiryDate | Datum im Format YYYY-MM-DD | Ende der Vertragslaufzeit bzw. des Versicherungsschutzes - dieser Wert kann sich naturgemäß zur Laufzeit des Vertrages ändern |
otherValues ist ein Text-Feld, welches wiederum Daten in JSON enthält.
Diese Felder werden auf Wunsch einzelner Nutzer bei bestimmten Dokumenten ausgelesen. Die Regeln zum Auslesen dieser Felder sind oft sehr speziell und nur für einzelne Dokumente überhaupt gegeben. Daher sind diese Felder nicht für den allgemeinen Gebrauch vorgesehen und auch nicht als zuverlässig zu betrachten.
| Feld | Beschreibung |
|---|---|
| idProposal | Antragsnummer (bisher nur VHV) |
| internationalBankAccountNumber | internationale Bankkontonummer |
| bankIdentifierCode | Bank Identifier Code |
| taxNumber | Steuernummer |
| taxRate | Steuersatz |
| valueAddedTaxIdentificationNumber | Umsatzsteuer-Identifikationsnummer |
| commercialRegisterNumber | Handelsregisternummer |
| E-Mail-Adresse | |
| nationality | Staatsangehörigkeit |
| salutation | Anrede |
| insuranceSum | Versicherungssumme |
| waitingTime | Wartezeit |
noClaimsBonusClass ist ein Text-Feld, welches wiederum Daten in JSON enthält. Folgende Felder können enthalten sein:
| Feld | Definition | Beschreibung |
|---|---|---|
| Haftpflicht | Integer | Zahlenwert der SF-Klasse für Haftpflicht |
| Kasko | Integer | Zahlenwert der SF-Klasse für Kasko |
meta ist ein Text-Feld, welches wiederum Daten in JSON enthält. Folgende Felder können enthalten sein:
| Feld | Definition | Beschreibung |
|---|---|---|
| Name | Text | Nachname des VN anhand der BiPRO-Daten ermittelt |
| Vorname | Text | Vorname des VN anhand der BiPRO-Daten ermittelt |
| Firma | Text | Firmenname des VN anhand der BiPRO-Daten ermittelt |
| Strasse | Text | Straße mit Hausnummer anhand der BiPRO-Daten ermittelt |
| PLZ | Text | Postleitzahl anhand der BiPRO-Daten ermittelt |
| Ort | Text | Ortsname anhand der BiPRO-Daten ermittelt |
| VSNR | Text | Versicherungsscheinnummer anhand der BiPRO-Daten ermittelt |
| vuNr | Text | VU-Nummer anhand der BiPRO-Daten ermittelt |
| ArtID | Text | Art des Geschäftsvorfalles laut BiPRO |
| KategorieID | Text | Kategorie des Geschäftsvorfalles laut BiPRO |
| contract | Unterobjekt - BiPRo-Daten dekodiert | Kunden- und Vertragsdaten in unserer internen Notation. |
| bipro | Unterobjekt mit den Meta-Daten | Das sind die Original-Daten, welche per BiPRO zur Datei geliefert wurden. |
| postbox_id | Integer | interne Id des Dokuments in der BiPRO-Box |
| user_config_name | Text | Lizenznummer des Nutzers der BiPRO-Box |
| confirmed | Integer | Flag zur manuellen Bestätigung der ausgelesenen Daten - nur bei einigen Nutzern aktiv |