Différences

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

--- serveurscrutari:json:type_motcle [2010/05/08 18:50] – vincent
+++ serveurscrutari:json:type_motcle [2017/11/05 14:46] (Version actuelle) – vincent
@@ Ligne 1: / Ligne 1: @@
 ====== type = motcle ======
-Cette requête JSON permet de récupérer la liste de mots-clés contenant la séquence de recherche dans une langue donnée. Cette requête est destinée notamment à la suggestion de recherche.
+Cette requête JSON permet de récupérer une liste de mots-clés suivant certains critères. Si le paramètre //motclelist// est utilisé, les autres paramètres sont ignorés, sinon ce sont des paramètres équivalents à ceux la recherche de mots-clés ou de fiches. Si aucun paramètre n'est indiqué, la requête renvoie l'intégralité des mots-clés.
-Les paramètres obligatoires sont les suivants :
+===== Paramètres =====
-  * //langs// : indique la langue (bien qu'il y ait un « s » à  « langs », une seule langue est acceptée pour le moment)
+==== Paramètres communs obligatoires ====
-  * //q// : indique la recherche à effectuer
-Les paramètres optionnels sont les suivants :
+  * //version// : version à utiliser (Version actuelle : 3)
-  * //limit// : nombre maximum de résultats envoyés (la valeur -1 indique l'absence de limite)
+==== Paramètres communs optionnels ====
+  * //thesauruslist// : limitation des mots-clés à certains thésaurus (ignoré si //motclelist// est défini)
+  * //motclefields// : détermine les champs à transmettre (voir [[serveurscrutari:json:motcle_fields|Champs des mots-clés]])
+  * //fieldvariant// : variante de champs à utiliser pour les fiches comme les mots-clés (voir le fichier [[serveurscrutari:config:fields|fields.xml]] et [[serveurscrutari:json:motcle_fields|Champs des mots-clés]]) (ignoré si //motclefields// est défini)
+==== Paramètres spécifiques optionnels ====
+  * //motclelist// : liste de codes de mots-clés, s'il est présent les autres paramètres sont ignorés
 ===== Objet retourné =====
+Version 3 :
+<code javascript>
+{
+  motcleArray: [ // tableau des mots-clés sélectionnés
+     { // chaque mot-clé est un objet
+         __motcle-fields__ // série de propriétés définies par le paramètre motclefields
+     }
+  ]
+}
+Version 2 :
+<code javascript>
+{
+  motcleArray: [ // tableau des mots-clés sélectionnés
+     { // chaque mot-clé est un objet
+         __motclefields__ // série propriétés définies par les paramètres motclefields ou fieldvariant
+     }
+  ]
+}
+</code>
+Version 1 (//motcleArray// était encapsulé dans un objet //motcleData//) :
 <code javascript>
 {
-  motcleSearchResult: {
+  motcleData: {
-    count: (nombre total de mot-clé),
+    motcleCount: … , //(nombre total de mots-clés),
-    infoArray:   //tableau des mots-clés, présent si count > 0 et infoArray.length = count
+    motcleArray: [ // tableau des mots-clés
-       [
+       { // chaque mot-clé est un objet
-           {      //chaque mot-clé est un objet avec les propriétés suivantes :
+           __motcle-fields__ // série de propriétés définies par le paramètre motclefields
-              codemotcle: (entier > 0, code du mot-clé),
+       }
-              codethesaurus: (entier > 0, code du thésaurus),
+     ]
-              lib: (chaine, libellé du mot-clé dans),
-              mlib: (chaine avec indication de la position des éléments de la chaine de recherche, voir ci-après)
-           },
-           {
-             ...
-            },
-           {
-             ...
-            }
-       ]
   }
 }
@@ Ligne 39: / Ligne 63: @@
 </code>
-La propriété //mlib// reprend le libellé en indiquant les emplacements des mots de la chaine de recherche. Ces emplacements sont signalés par des doubles crochets //[[// et //]]//. Entre les doubles crochets ouvrants sont insérés la position du mot en question dans la chaine de recherche.
-Par exemple, une recherche « gouv legit » donnera : ''[1[gouv]]ernance [2[legit]]ime''. Ce mécanisme permet de surligner les mots recherchés avec, éventuellement, des couleurs différentes.