Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

Structure of JSON Result Object

This document describes the structure and format of the JSON result object as returned by the result object.

The JSON result is an array of objects ([{ … }, { … }]), one object for each field found in the data. Each field has 3 attributes:

  • name: Holds the name of the field. Type: string.

  • rawString: Holds the raw string data as found in the code. Type: string

  • parsed: Holds the parsed representation of the field. For example, this field might contain an object with year, month and day values, or just be a number. For a field with a given name, the format of the data is fixed. Type: string, float, int, object boolean, null, or array.

The name and the precise form of the parsed data-structure is format and field specific. Consult the documentation for each data format format docs for more information.

The following example shows the JSON output of the GS1 code 1719060010SCANDIT123:

  [
    {
        "name" : "17",
        "parsed" : {
            "month" : 6,
            "year" : 2019
        },
        "rawString" : "190600"
    },
    {
        "name" : "10",
        "parsed" : "SCANDIT123",
        "rawString" : "SCANDIT123"
    }
]