Request the parameters

To retrieve the available parameters, send a GET request to the following URI: https://localhost/flexicapture12/Server/MobileApp. When you work with tenants, also pass the tenant name as a parameter: https://localhost/flexicapture12/Server/MobileApp?Tenant=[tenant name].

The user must have Scanning Operator permissions.

The server sends a response in JSON format encoded in UTF-8. The root of the JSON response contains the values of the projectName and batchType parameters if an Administrator configured them on the server. The list of all projects available to the user follows the values configured on the server. Each project contains the list of batches, along with the attached list of document types and registration parameters that an Administrator specified on the server.

JSON response example

The following example shows a JSON response with the available projects, batch types, and registration parameters:

{
    "batchType":"",
    "projectName":"<project name>"
    "projects":
    [
        {
            "name" : "<available project>",
            "batchTypes" :
            [
                {
                    "name" : "<Default>"
                },
                {
                    "name" : "<batch type 1>"
                    "regParams" :
                    [
                        {
                            "name" : "<registration parameters 1>",
                            "isRequired" : "true"
                        },
                        {
                            "name" : "<registration parameters 2>",
                            "isRequired" : "false"
                        }
                    ]
                }
            ]
        }
    ]
}

Web Services Mobile API

Upload files to the server

⌘I

Programmer's Guide

Reporting Service

JSON response example

​JSON response example

JSON response example