Demander les paramètres

Envoyez une requête GET à l’API mobile ABBYY FlexiCapture pour récupérer sous forme de JSON les projets disponibles, les types de lots et les paramètres d’enregistrement pour les clients mobiles.

Pour récupérer les paramètres disponibles, envoyez une requête GET à l’URI suivante :

https://localhost/flexicapture12/Server/MobileApp

Lorsque vous travaillez avec des tenants, transmettez également le nom du tenant comme paramètre :

https://localhost/flexicapture12/Server/MobileApp?Tenant=[tenant name]

L’utilisateur doit disposer des autorisations d’opérateur de numérisation.

​

Structure de la réponse

Le serveur envoie une réponse au format JSON encodée en UTF-8. La racine de la réponse contient les valeurs des paramètres projectName et batchType si un Administrateur les a configurés sur le serveur.

Ces valeurs sont suivies de la liste de tous les projets accessibles à l’utilisateur. Chaque projet répertorie ses types de lots, ainsi que les types de documents et les paramètres d’enregistrement qu’un Administrateur a spécifiés sur le serveur.

​

Exemple de réponse JSON

L’exemple suivant présente une réponse JSON avec les projets disponibles, les types de lots et les paramètres d’enregistrement :

{
    "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"
                        }
                    ]
                }
            ]
        }
    ]
}