Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
serveurscrutari:json:type_motcle [2010/05/08 18:44] vincent |
serveurscrutari:json:type_motcle [2017/11/05 14:46] vincent |
||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
====== type = motcle ====== | ====== 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 | + | |
+ | * //version// : version à utiliser (Version actuelle : 3) | ||
+ | |||
+ | ==== 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é ===== | ===== Objet retourné ===== | ||
+ | |||
+ | Version 3 : | ||
<code javascript> | <code javascript> | ||
{ | { | ||
- | motcleSearchResult: { | + | motcleArray: [ // tableau des mots-clés sélectionnés |
- | count: (nombre total de mot-clé), | + | { // chaque mot-clé est un objet |
- | infoArray: //tableau des mots-clés, présent si count > 0 et infoArray.length = count | + | __motcle-fields__ // série de propriétés définies par le paramètre motclefields |
- | [ | + | } |
- | { //chaque mot-clé est un objet avec les propriétés suivantes : | + | ] |
- | codemotcle: (entier > 0, code du mot-clé), | + | } |
- | codethesaurus: (entier > 0, code du thésaurus), | + | |
- | lib: (chaine, libellé du mot-clé dans), | + | Version 2 : |
- | mlib: (chaine avec indication de la position des éléments de la chaine de recherche, voir ci-après) | + | |
- | }, | + | <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> | ||
+ | { | ||
+ | motcleData: { | ||
+ | motcleCount: … , //(nombre total de mots-clés), | ||
+ | motcleArray: [ // tableau des mots-clés | ||
+ | { // chaque mot-clé est un objet | ||
+ | __motcle-fields__ // série de propriétés définies par le paramètre motclefields | ||
+ | } | ||
+ | ] | ||
} | } | ||
} | } | ||
</code> | </code> | ||
+ | |||
+ | |||