JSON-Eingabe - ABBYY Documentation

JSON-Dateien enthalten Datenstrukturen, die die Anzahl, die Typen und die Namen der Dokumente sowie die Anzahl und die Namen der Seiten für jedes Dokument angeben. Um den mobilen Upload für die Szenarien eines bestimmten Benutzers zu konfigurieren, verwenden Sie die JSON-Datei im mobilen Upload-Link. Der Parameter md akzeptiert eine JSON-Datei in zwei Formaten: als direkt codierter Link oder als codiertes JSON. So verwenden Sie einen codierten Link:

Generieren Sie einen Direktzugriffslink zu der JSON-Datei.

Der Link sollte mit „http://“ oder „https://“ beginnen.

Codieren Sie den erhaltenen Link in ein URL-codiertes Format.
Geben Sie die codierte URL als Wert für den Parameter md im mobilen Upload-Link an.

So verwenden Sie ein codiertes JSON:

Codieren Sie die JSON-Datei in ein URL-codiertes Format.
Geben Sie die codierte JSON-Datei als Wert für den Parameter md im mobilen Upload-Link an.

JSON-Struktur

TransactionStructure definiert eine Menge von Dokumenten, die der Benutzer während einer mobilen Upload-Sitzung erfassen soll, um sie anschließend in einem Vorgang weiterzuverarbeiten. Der Vorgang startet erst, wenn alle Dokumente erfasst wurden.

Eigenschaften	Wert	Beschreibung
`version`	`2.4`	Die aktuelle ABBYY Vantage-Version. Hinweis: Der Wert sollte dem Wert des `v`-Parameters im mobilen Upload-Link entsprechen.
`elements`	ElementStructure	Die Struktur der Elementsammlung.

ElementStructure definiert eine Sammlung aus einem oder mehreren Sätzen von Dokumenten, die der Benutzer zur weiteren Verarbeitung in einem Vorgang erfassen soll.

Eigenschaften	Wert	Beschreibung
`type`	`standalone`	Definiert eine Sammlung mit einem Satz von Dokumenten.
`type`	`single_choice`	Definiert eine Sammlung mit mehreren Sätzen von Dokumenten. Hinweis: Erfordert mindestens zwei angegebene Sätze von Dokumenten.
`name`		Der Name des Dokumentensatzes, der auf dem Bildschirm Dokumente erfassen in der Mikroanwendung angezeigt wird. Hinweis: Nur für den Typ `single_choice` verfügbar.
`document`	DocumentStructure	Die Struktur eines Dokuments im Satz. Hinweis: Nur für den Typ `standalone` verfügbar.
`documents`	DocumentStructure	Die Struktur aller Dokumente im Satz. Hinweis: Nur für den Typ `single_choice` verfügbar.

DocumentStructure definiert eine Sammlung von Eigenschaften für jedes Dokument im Satz.

Eigenschaften	Wert	Beschreibung
`type`	`idcard`	Definiert das Erfassen beider Seiten (Vorder- und Rückseite) eines Personalausweises.
`type`	`passport`	Definiert das Erfassen der ersten Seite eines Reisepasses.
`type`	`document`	Definiert das Erfassen beliebiger Dokumente.
`name`		Der Name des Dokuments, der auf dem Bildschirm Dokumente erfassen in der Mikroanwendung angezeigt wird.
`count`	`1,2,3...`	Die erforderliche Anzahl von Dokumenten, die in einem Vorgang erfasst werden muss. Der Standardwert ist „1“. Hinweis: Der Upload startet erst, wenn alle Dokumente erfasst wurden.
`count`	`any`	Die Anzahl der Dokumente, die in einem Vorgang erfasst werden soll. Hinweis: Der Upload startet mit einer beliebigen Anzahl erfasster Dokumente.
`galleryEnabled`	`false/true`	Legt fest, ob das Hochladen von Bildern von Dokumentseiten aus der Gerätegalerie für dieses Dokument erlaubt ist.
`pages`	PagesStructure	Die Struktur der Dokumentseiten.

PagesStructure definiert eine Sammlung von Eigenschaften für die Dokumentseiten, die der Benutzer erfassen soll.

Eigenschaften	Wert	Beschreibung
`name`	`Front side/Back side`	Die Namen der Seiten eines Personalausweises.
`name`	`First page with photo`	Der Name der ersten Seite eines Reisepasses.
`name`	`Document page name`	Die Namen der Seiten eines beliebigen Dokuments.
`count`	`1,2,3...`	Die erforderliche Anzahl von Seiten, die für das Dokument erfasst werden muss. Der Standardwert ist „1“. Der Upload startet erst, wenn alle Seiten des Dokuments erfasst wurden. Hinweis: Der erforderliche Wert für Vorder- und Rückseite eines Personalausweises ist „1“.
`count`	`any`	Die Anzahl der Seiten, die für ein beliebiges Dokument erfasst werden soll. Der Upload startet mit einer beliebigen Anzahl erfasster Seiten. Hinweis: Der erforderliche Wert für die erste Seite eines Reisepasses ist „1“. Der erforderliche Wert für andere Reisepassseiten ist „any“.

JSON-Beispiel

Dieses JSON-Beispiel definiert die Dokumentstruktur für einen Bankantrag. Im Rahmen einer Mobile-Upload-Sitzung soll der Benutzer die folgenden Dokumentseiten zur weiteren Verarbeitung in einem Vorgang erfassen:

Die erste Seite des Reisepasses.
Alle Seiten des Antrags.
Einen Wohnsitznachweis, also Seiten des Mietvertrags oder Seiten einer Versorgungsrechnung.

JSON-Beispiel anzeigen

{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "name": "Passport",
        "type": "passport",
        "count": "1",
        "galleryEnabled": false,
        "pages": [
          {
            "name": "First page with photo",
            "count": "1"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "name": "Application",
        "type": "document",
        "count": "1",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Page",
            "count": "any"
          }
        ]
      }
    },
    {
      "type": "single_choice",
      "name": "Proof of residence",
      "documents": [
        {
          "name": "Rental agreement",
          "type": "document",
          "count": "1",
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Page",
              "count": "any"
            }
          ]
        },
        {
          "name": "Utility bill",
          "type": "document",
          "count": "2",
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Page",
              "count": "any"
            }
          ]
        }
      ]
    }
  ]
}

​JSON-Struktur

​JSON-Beispiel

JSON-Struktur

JSON-Beispiel