Différences

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

--- serveurscrutari:json:motcle_fields [2011/03/18 21:32] – vincent
+++ serveurscrutari:json:motcle_fields [2020/10/12 15:54] (Version actuelle) – [Champs des mots-clés] vincent
@@ Ligne 1: / Ligne 1: @@
 ====== Champs des mots-clés ======
-Comme pour les fiches, les données transmises pour un mot-clé dépendent d'un paramètre : //motcle-fields//. En son absence, la requête renverra deux champs uniquement : le code du mot-clé et le code de son thésaurus.
+Comme pour les fiches, les données transmises pour un mot-clé dépendent du paramètre //motclefields//, de la variante de champs indiquée par //fieldvariant// ou de la variante par défaut si aucun des deux paramètres précédents n'est défini.
-La valeur de ce paramètre est une liste de champs séparés par une virgule :
+La valeur du paramètre //fichefields// ou de l'attribut //@fields// de l'élément !!<motcle>!! dans [[serveurscrutari:config:fields|fields.xml]] est une liste de champs séparés par une virgule avec les valeurs suivantes :
-  * //codemotcle// : code du mot-clé
+  * //-codemotcle// : par défaut, le code du mot-clé est toujours inséré, ce paramètre permet de l'éviter
   * //codethesaurus// : code du thésaurus
   * //codebase// : code de la base du thésaurus
+  * //basename// : nom de la base tel que dans l'URI du mot-clé (introduit également le champ //authority//)
+  * //thesaurusname// : nom du thésaurus tel que dans l'URI du mot-clé
+  * //motcleid// : partie identifiant du mot-clé dans l'URI
+  * //labels// : libellés du mot-clé
+  * //mlabels// : libellés marqués du mot-clé, seuls les libellés qui ont contribué à la recherche sont inclus (même notion que le titre marqué dans [[serveurscrutari:json:fiche_fields|Champs des fiches]])
+  * //mlabels_all// : comme précédent mais tous les libellés sont inclus, y compris les non marqués
+  * //attrs// : attributs du mot-clé
+  * //score// : score du mot-clé (correspond au nombre de termes de la recherche dans le libellé du mot-clé)
+===== Structure de l'objet résultant =====
+Note : même si un champ est indiqué dans //motclefields//, la propriété peut être absente dans l'objet JSON correspondant si la valeur est nulle.
+Version 3
+<code javascript>
+{
+  codemotcle: … , // code du mot-clé, toujours présent sauf si -codemotcle (entier > 0)
+  codethesaurus: … , // champ 'codethesaurus' (entier > 0)
+  codebase: … , // champ 'codebase' (entier > 0)
+  authority: … , //autorité productrice de la base tel que dans l'URI (chaine)
+  basename: …, // nom technique de la base tel que dans l'URI (chaine)
+  thesaurusname: …, // nom technique du thésaurus tel que dans l'URI (chaine)
+  motcleid: …, // champ 'motcle-id' (chaine)
+  labelMap: { // si champ 'labels', tableau associatif des libellés,
+    (clé): …  // la clé est la langue, la valeur le libellé dans la langue
+  },
+  mlabelArray: [ // si champ 'mlabels' ou 'mlabels_def, tableau des libellés marqués
+    {
+      lang: …, // code de langue (format ISO, chaine)
+      mvalue: [ // tableau du libellé marqué
+        // (voir les champs des fiches)
+      ]
+    }
+  ],
+  attrMap: { // si champ 'attrs', tableau associatif des attributs
+    (clé): [ // la clé est celle de l'attribut, la valeur est le tableau des valeurs de l'attribut
+    ]
+  }
+}
+Version 2 et inférieures :
+<code javascript>
+{
+  codemotcle: … , // code du mot-clé, toujours présent sauf si -codemotcle (entier > 0)
+  codethesaurus: … , // champ 'codethesaurus' (entier > 0)
+  codebase: … , // champ 'codebase' (entier > 0)
+  basename: …, // nom technique de la base tel que dans l'URI (chaine)
+  thesaurusname: …, // nom technique du thésaurus tel que dans l'URI (chaine)
+  motcleid: …, // champ 'motcle-id' (chaine)
+  libelleArray: [ // si champ 'labels', tableau des libellés sous forme d'objet,
+    {
+      lang: …, // code de langue (format ISO, chaine)
+      lib: …, // libellé dans la langue
+    }
+  ],
+  mlibelleArray: [ // si champ 'mlabels' ou 'mlabels_def, tableau des libellés marqués
+    {
+      lang: …, // code de langue (format ISO, chaine)
+      mlib: [ // tableau du libellé marqué
+        // (voir les champs des fiches)
+      ]
+    }
+  ]
+}
+</code>