Différences

Ci-dessous, les différences entre deux révisions de la page.

--- dev:api:webservices:json [2021/11/25 08:01]
florian [Uploader un fichier]
+++ dev:api:webservices:json [2025/01/06 14:13] (Version actuelle)
florian [Supprimer un enregistrement]
@@ Ligne 14: / Ligne 14: @@
 Le mot de passe doit être envoyé haché en md5 ce qui donne pour //admin// : 21232f297a57a5a743894a0e4a801fc3
+=== URL ===
 <code>
-http://localhost/ezged3/data/service.php/?service=sec/authenticate&login=admin&pwd=21232f297a57a5a743894a0e4a801fc3
+POST <URL_GED>/data/service.php?service=sec/authenticate
 </code>
-<code>
+**Content-type:** application/x-www-form-urlencoded
+=== Paramètres ===
+  * **login**: le login avec lequel s'authentifier
+  * **pwd**: le mot de passe (haché avec MD5)
+=== Exemple ===
+| **Paramètre** | **Valeur** |
+| login| admin|
+| pwd | 21232f297a57a5a743894a0e4a801fc3 |
+Réponse:
+<file json>
 {
- "errorcode" : 0,
+    "errorcode": 0,
- "errormsg" : "You're authenticated !",
+    "errormsg": "You're authenticated !",
- "rows" : {
+    "rows": {
-    "sessionid": "778077913"
+        "SECUSRPAR_LANG": "fr_FR",
- }
+        "SECUSRPAR_FMTFLOAT": "xx3xx,xxxx",
+....
+....
+        "SECUSRPAR_TOOLBARRIGHT": "1",
+        "sessionid": "640418229",
+        "IHMVERSION": 0,
+        "URLADMIN": "http://localhost/ezged33/data/../apps/administration",
+        "LOGODIST": "resources/images/distributeur.jpg",
+        "URLDIST": "http://www.ezged.com",
+        "ACTIVATE_OLDDASHBOARD": 0,
+        "ACTIVATE_PREVIEWDASHBOARD": null,
+        "URLDOC": "resources/doc/manuel_utilisateur_v3.pdf"
+    }
 }
-</code>
+</file>
-Nb: Ceci n'est qu'une partie de la réponse à la demande d'authentification. Le service renvoi également les paramètres du profil utilisateur mais nous n'en auront pas besoin au cours de  ce tutoriel.
+Il s'agit d'un aperçu de la réponse, l'élément le plus important est l'identifiant de session **sessionid**
 ==== Maintenir la connexion ====
 La connexion est maintenue 60 secondes. Au-delà si aucun appel à un service n'est effectué sur cette session elle est supprimée. Si l'on souhaite maintenir la connexion il existe un service dédié à cela que voici:
@@ Ligne 37: / Ligne 65: @@
 http://localhost/ezged3/data/service.php?service=secses/keepalive
 </code>
+Paramètres:
+  * **sessionid**: l'identifiant de la session ezged à maintenir ouverte.
 <code>
@@ Ligne 63: / Ligne 94: @@
 Service à appeler :
 <code>
-http://localhost/ezged3/data/service.php?service=secses/delete?sessionid=414034936&secsesid=414034936
+http://localhost/ezged3/data/service.php?service=secses/delete?sessionid=414034936
 </code>
@@ Ligne 177: / Ligne 208: @@
 ==== Rechercher sur une Vue ====
+=== URL ===
 <code>
-http://localhost/ezged/data/service.php?service=query/getexec&qryid=656&limitstart=0&limitgridlines=20&qryusrffqn=BULLETINS_ID&qryusrop==&qryusrval=26
+GET <URL_GED>/data/service.php?service=query/getexec
 </code>
-  * qryid : Identifiant de la requête.
+=== Paramètres ===
-  * limitgridlines : permet de limiter le nombre de résultats retournés.
+  * **sessionid**: Identifiant de session EzGED
-  * limitstart :
+  * **qryid** : Identifiant de la requête/vue.
-  * qryusrffqn : Nom du champ de la base de donnée sur lequel recherché.
+  * **qryusrffqn** : Nom de champ sur lequel filtrer
-  * qryusrop : Type d'opérateur (**=**, **>=**, **%%<=%%**, **like**).
+  * **qryusrop** : Type d'opérateur (**=**, **>=**, **%%<=%%**, **like**, **in**).
-  * qryusrval : Valeur à rechercher.
+  * **qryusrval** : Valeur à rechercher.
+  * **limitgridlines** : permet de limiter le nombre de résultats retournés.
+  * **limitstart** : index de départ pour les résultats à retourner
-Exemple de retour:
+N.b: les paramètres *qryusrffqn*, *qryusrop* et *qryusrval* acceptent des listes
+afin d'effectuer un filtrage sur plusieurs champs de la requête. Le champ, l'opérateur et la valeur doivent être à la même position dans leurs listes respectives.
+=== Exemple 1===
+| **Paramètre** | **Valeur** |
+| sessionid | 1607761151|
+| qryid | 675 |
+| qryusrffqn | ["lstdosone.LSTDOSONE_LIB","one.ONE_LIB"] |
+| qryusrop | ["=","="] |
+| qryusrval | ["Client","Inconnu"] |
+Url d'appel :
 <code>
+http://localhost/ezged/data/service.php?service=query/getexec&sessionid=1607761151&qryid=675&qryusrffqn=["lstdosone.LSTDOSONE_LIB","one.ONE_LIB"]&qryusrop=["=","="]&qryusrval=["Client","Inconnu"]
+</code>
+Réponse:
+<file json>
 {
-	"rows" : [{
+    "errorcode": 0,
-			"type" : "row",
+    "errormsg": "ok",
-			"BULLETINS_ID" : "26",
+    "rows": [
-			"BULLETINS_MAIL" : "florian@ezdev.fr",
+        {
-			"BULLETINS_DATESCAN" : "2017-06-29 10:51:19",
+            "ONE_FLAG": 0,
-			"BULLETINS_CFECVU" : "1",
+            "ONE_DATE": "2022-01-14 16:54:42",
-			"BULLETINS_NOM" : "HUGO",
+            "ONE_ID": 580,
-			"BULLETINS_SOCIETE" : "@DBNULLVALUE",
+            "LSTTIERSONE_LIB": null,
-			"BULLETINS_ANNEE" : "2017",
+            "LSTTYPDOCONE_LIB": null,
-			"BULLETINS_BRUT" : "2300.0",
+            "LSTDOSONE_LIB": "Client",
-			"BULLETINS_CFECDEPOSE" : "0",
+            "year(one.ONE_DATE)": 2022,
-			"BULLETINS_MOIS" : "6",
+            "type": "row",
-			"BULLETINS_CIVILITE" : "M",
+            "ONE_TEXTE": "",
-			"BULLETINS_PRENOM" : "VICTOR"
+            "ONE_LIB": "inconnu"
-		}
+        }
-	],
+    ],
-	"errorcode" : 0,
+    "count": 1
-	"errormsg" : "ok",
-	"count" : 1
 }
+</file>
+=== Exemple 2===
+Recherche avec opérateur IN sur le champ ONE_LIB
+| **Paramètre** | **Valeur** |
+| sessionid | 1607761151|
+| qryid | 675 |
+| qryusrffqn | ["lstdosone.LSTDOSONE_LIB","one.ONE_LIB"] |
+| qryusrop | ["=","in"] |
+| qryusrval | ["Client","Inconnu,test"] |
+Url d'appel :
+<code>
+http://localhost/ezged/data/service.php?service=query/getexec&sessionid=1607761151&qryid=675&qryusrffqn=["lstdosone.LSTDOSONE_LIB","one.ONE_LIB"]&qryusrop=["=","in"]&qryusrval=["Client","Inconnu,test"]
 </code>
+Réponse:
+<file json>
+{
+    "count": 2,
+    "errorcode": 0,
+    "errormsg": "ok",
+    "rows": [
+        {
+            "LSTDOSONE_LIB": "Client",
+            "ONE_DATE": "2022-01-14 16:54:42",
+            "ONE_FLAG": 0,
+            "ONE_ID": 580,
+            "ONE_LIB": "inconnu",
+            "type": "row"
+        },
+        {
+            "LSTDOSONE_LIB": "Client",
+            "ONE_DATE": "2019-07-30 10:02:30",
+            "ONE_FLAG": 0,
+            "ONE_ID": 41,
+            "ONE_LIB": "test",
+            "type": "row"
+        }
+    ]
+}
+</file>
 ==== Recherche Globale ====
@@ Ligne 513: / Ligne 608: @@
 POST <URL_GED>/data/service.php?service=doctbl/insertrow
 </code>
+Les paramètres sont à envoyer via le payload de la requête.
+Content-type: application/x-www-form-urlencoded
 === Paramètres ===
@@ Ligne 551: / Ligne 649: @@
 POST <URL_GED>/data/service.php?service=doctbl/updaterow
 </code>
+Les paramètres sont à envoyer via le payload de la requête.
+Content-type: application/x-www-form-urlencoded
 === Paramètres ===
@@ Ligne 581: / Ligne 682: @@
 }
 </file>
+==== Supprimer un enregistrement ====
+=== URL ===
+<code>
+POST <URL_GED>/data/service.php?service=doctbl/deleterowwfiles
+</code>
+Les paramètres sont à envoyer via le payload de la requête.
+Content-type: application/x-www-form-urlencoded
+=== Paramètres ===
+  * **sessionid**: Identifiant de session EzGED
+  * **tfqn**: nom de la table sur laquelle faire l'insertion
+  * **field_ID** : nom du champ clé primaire
+  * **value_ID** : clé primaire de l'enregistrement à modifier
+  * **qryid** : Identifiant de la requête depuis laquelle a lieu la suppression
+=== Exemple ===
+| **Paramètre** | **Valeur** |
+| sessionid | 874249274 |
+| tfqn |one |
+| field_ID | ONE_ID |
+| value_ID | 542 |
+| qryid | 42 |
+Réponse:
+<file json>
+{
+	"errorcode" : 0,
+	"errormsg" : "ok",
+	"rows" : [],
+	"count" : 0
+}
+</file>
@@ Ligne 626: / Ligne 769: @@
 	"chunkpart": false,
 	"message": "File successfully uploaded.",
-	"filePath": "F:\\nchp\\var\\spool\\ezged\\instance\/enqueued\/albatros_image.1.pdf"
+	"filePath": "F:\\nchp\\var\\spool\\ezged\\instance\/enqueued\/document_test.pdf"
 }
 </code>
@@ Ligne 641: / Ligne 784: @@
 <code>
-http://localhost/ezged/data/service.php?service=docpak/addpages&tfqn=courriers&rsid=118&file=D:\import\courrier_exemple.pdf&start=-1&ocr=1
+http://localhost/ezged/data/service.php?service=docpak/addpages&tfqn=courriers&rsid=118&file=F:\\nchp\\var\\spool\\ezged\\instance\/enqueued\/document_test.pdf&start=-1&ocr=1
 </code>

EzGED Wiki

Outils pour utilisateurs

Outils du site

Différences

Outils de la page