Zum Hauptinhalt springen
JSON-Dateien enthalten Datenstrukturen, die die Anzahl, Typen und Namen der Dokumente sowie die Anzahl und Namen der Seiten für jedes Dokument festlegen. 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 kann eine JSON-Datei in zwei Formaten akzeptieren: direkt codierter Link oder codiertes JSON. So verwenden Sie einen codierten Link:
  1. Generieren Sie einen Direktzugriffslink zur JSON-Datei.
Hinweis: Der Link sollte mit „http://“ oder „https://“ beginnen.
  1. Codieren Sie den erhaltenen Link im URL-codierten Format.
  2. Geben Sie die codierte URL als Wert für den Parameter md im mobilen Upload-Link an.
So verwenden Sie ein codiertes JSON:
  1. Codieren Sie die JSON-Datei im URL-codierten Format.
  2. 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.
EigenschaftenWertBeschreibung
version2.4Die aktuelle ABBYY Vantage-Version. Hinweis: Der Wert sollte dem Wert des v-Parameters im mobilen Upload-Link entsprechen.
elementsElementStructureDie 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.
EigenschaftenWertBeschreibung
typestandaloneDefiniert eine Sammlung mit einem Satz von Dokumenten.
typesingle_choiceDefiniert eine Sammlung mit mehreren Sätzen von Dokumenten. Hinweis: Erfordert mindestens zwei angegebene Sätze von Dokumenten.
nameDer Name des Dokumentensatzes, der auf dem Bildschirm Dokumente erfassen in der Mikroanwendung angezeigt wird. Hinweis: Nur für den Typ single_choice verfügbar.
documentDocumentStructureDie Struktur eines Dokuments im Satz. Hinweis: Nur für den Typ standalone verfügbar.
documentsDocumentStructureDie 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.
EigenschaftenWertBeschreibung
typeidcardDefiniert das Erfassen beider Seiten (Vorder- und Rückseite) einer Ausweiskarte.
typepassportDefiniert das Erfassen der ersten Seite eines Reisepasses.
typedocumentDefiniert das Erfassen beliebiger Dokumente.
nameDer Name des Dokuments, der auf dem Bildschirm Dokumente erfassen in der Mikroanwendung angezeigt wird.
count1,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.
countanyDie Anzahl der Dokumente, die in einem Vorgang erfasst werden soll. Hinweis: Der Upload startet mit einer beliebigen Anzahl erfasster Dokumente.
galleryEnabledfalse/trueLegt fest, ob das Hochladen von Bildern von Dokumentseiten aus der Gerätegalerie für dieses Dokument erlaubt ist.
pagesPagesStructureDie Struktur der Dokumentseiten.
PagesStructure definiert eine Sammlung von Eigenschaften für die Dokumentseiten, die der Benutzer erfassen soll.
EigenschaftenWertBeschreibung
nameFront side/Back sideDie Namen der Seiten einer Ausweiskarte.
nameFirst page with photoDer Name der ersten Seite eines Reisepasses.
nameDocument page nameDie Namen der Seiten eines beliebigen Dokuments.
count1,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 einer Ausweiskarte ist „1“.
countanyDie 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

Ein Beispiel für eine JSON-Struktur, um eine bestimmte Anzahl von Reisepassdokumenten mit einer festgelegten Seitenzahl zu erfassen: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "passport",
        "name": "Reisepass",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Erste Seite mit Foto",
            "count": 1
          },
          {
            "name": "Weitere Seiten",
            "count": "beliebig"
          }
        ]
      }
    }
  ]
}
Beispiel einer JSON-Struktur zum Erfassen eines von mehreren vordefinierten Dokumenten: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "single_choice",
      "name": "Dokument",
      "documents": [
        {
          "type": "idcard",
          "name": "Personalausweis",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Vorderseite",
              "count": 1
            },
            {
              "name": "Rückseite",
              "count": 1
            }
          ]
        },
        {
          "type": "passport",
          "name": "Reisepass",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Erste Seite mit Foto",
              "count": 1
            },
            {
              "name": "Weitere Seiten",
              "count": "any"
            }
          ]
        }
      ]
    }
  ]
}
Ein Beispiel für eine JSON-Struktur zum Erfassen mehrerer Dokumente mit einem optionalen Ausweis: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "document",
        "name": "Rechnung",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Seite",
            "count": "beliebig"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "type": "idcard",
        "name": "Ausweis",
        "count": "beliebig",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Vorderseite",
            "count": 1
          },
          {
            "name": "Rückseite",
            "count": 1
          }
        ]
      }
    }
  ]
}