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 Dernière révision Les deux révisions suivantes | ||
serveurscrutari:json:type_qfiche [2017/09/28 15:49] vincent [Objet retourné] |
serveurscrutari:json:type_qfiche [2019/11/26 01:12] vincent [Objet retourné] |
||
---|---|---|---|
Ligne 9: | Ligne 9: | ||
* //q// : séquence de recherche (est ignoré si qid est indiqué) (voir [[serveurscrutari:json:qsyntax|Syntaxe d'une recherche]]) | * //q// : séquence de recherche (est ignoré si qid est indiqué) (voir [[serveurscrutari:json:qsyntax|Syntaxe d'une recherche]]) | ||
- | * //version// : version à utiliser (Version actuelle : 1) | + | * //version// : version à utiliser (Version actuelle : 3) |
==== Paramètres communs optionnels ==== | ==== Paramètres communs optionnels ==== | ||
Ligne 27: | Ligne 27: | ||
* //in: …// : comme précédemment sauf que le point de départ n'est évalué que pour les catégories listées après //in:// | * //in: …// : comme précédemment sauf que le point de départ n'est évalué que pour les catégories listées après //in:// | ||
* //fichefields// : champs qui se retrouveront dans les objets du tableau //ficheArray// (voir [[serveurscrutari:json:fiche_fields|Champs des fiches]]) | * //fichefields// : champs qui se retrouveront dans les objets du tableau //ficheArray// (voir [[serveurscrutari:json:fiche_fields|Champs des fiches]]) | ||
- | * //motclefields// : champs qui se retrouveront dans les objets du tableau //motcleMap// (voir [[serveurscrutari:json:motcle_fields|Champs des mots-clés]]) | + | * //motclefields// : champs qui se retrouveront dans les objets du tableau //motcleArray// (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:fiche_fields|Champs des fiches]]) (ignoré si //fichefields// ou //motclefields// sont définis) | ||
//corpuslist//, //baselist//, //categorylist// et //thesauruslist// peuvent être utiliser en mode d'exclusion, c'est à dire pour indiquer des corpus, des bases, des catégories ou des thésaurus qui doivent être exclus de la recherche. Pour cela, il faut commencer le paramètre par un point d'exclamation **!**. | //corpuslist//, //baselist//, //categorylist// et //thesauruslist// peuvent être utiliser en mode d'exclusion, c'est à dire pour indiquer des corpus, des bases, des catégories ou des thésaurus qui doivent être exclus de la recherche. Pour cela, il faut commencer le paramètre par un point d'exclamation **!**. | ||
Ligne 39: | Ligne 40: | ||
==== Paramètres spécifiques optionnels ==== | ==== Paramètres spécifiques optionnels ==== | ||
- | * //intitules// : rajoute des intitulés, peut prendre les valeurs //corpus// (intitulés des corpus) et //complement// (intitulés des compléments) (séparés par une virgule), les intitulés sont dans la langue de l'interface ou, sinon, dans la langue par défaut du corpus, peut également prendre la valeur attributes pour indiquer l'insertion du descriptif des attributs | + | * //insert//: gère les objets supplémentaires dans l'objet Json retourné, les valeurs possibles (séparées par des virgules) sont les suivantes : |
+ | * //-motclearray// : le tableau des mots-clés est inséré par défaut, ce paramètre permet de l'éviter | ||
+ | * //-searchmeta// : les informations sur la recherche sont insérées par défaut, ce paramètre permet de l'éviter | ||
+ | * //engineinfo// : insère les informations sur le moteur (équivalent de [[serveurscrutari:json:type_engine|type = engine&data=all]] moins les statistiques) | ||
* //origin// : origine de la recherche (chaine libre qui permet d'avoir une idée dans les journaux de l'origine de la recherche) | * //origin// : origine de la recherche (chaine libre qui permet d'avoir une idée dans les journaux de l'origine de la recherche) | ||
* //flt// (//flt-indexation//, //flt-date//, //flt-qid//) : filtres appliqués constituant une présélection de fiches avant la recherche (voir [[serveurscrutari:json:filtersyntax|Syntaxe des filtres]]) | * //flt// (//flt-indexation//, //flt-date//, //flt-qid//) : filtres appliqués constituant une présélection de fiches avant la recherche (voir [[serveurscrutari:json:filtersyntax|Syntaxe des filtres]]) | ||
Ligne 48: | Ligne 52: | ||
===== Objet retourné ===== | ===== Objet retourné ===== | ||
+ | |||
+ | Version 3 : | ||
+ | |||
+ | <code javascript> | ||
+ | { | ||
+ | ficheSearchResult: { | ||
+ | searchMeta : { //objet contenant les informations sur la recherche | ||
+ | q: … , //séquence de recherche (chaine) | ||
+ | qId: … , //identifiant de la recherche (chaine) | ||
+ | lang: … , //langue utilisée pour l'interface (valeur du paramètre lang s'il était présent) (chaine) | ||
+ | ficheCount: … , //nombre de fiches trouvées | ||
+ | ficheMaximum: … , //nombre de fiches sur lesquelles a porté la recherche | ||
+ | motcleCount: … , //nombre de mots-clés contenant au moins un des composants de la séquence de recherche | ||
+ | options: { // objet des options | ||
+ | baselist: { // si la recherche se fait sur une sélection de base | ||
+ | exclude: …, //booléen sir la liste est exclusive ou inclusive | ||
+ | array: [ | ||
+ | … code des bases | ||
+ | ] | ||
+ | }, | ||
+ | langlist:, // même modèle que langlist | ||
+ | corpuslist:, // même modèle que corpuslist | ||
+ | thesauruslist: // même modèle que thesauruslist | ||
+ | } | ||
+ | }, | ||
+ | ficheGroupType: … , // type de groupement des fiches, prend la valeur "category" (regroupement par catégorie) ou "none" (pas de regroupement) | ||
+ | ficheGroupArray: [ //tableau des groupes de fiches répondant aux critères de recherche, vide s'il n'y aucune fiche | ||
+ | { // chaque groupe de fiches est un objet | ||
+ | category: { // objet décrivant la catégorie du groupement, présent uniquement si ficheGroupType="category", autrement dit, si des catégories sont définies pour le moteur en question | ||
+ | { | ||
+ | rank: … , // rang de la catégorie(entier > 0) | ||
+ | name: … , // nom de la catégorie (chaine) | ||
+ | title: … // intitulé de la catégorie dans la langue d'interface (chaine) | ||
+ | }, | ||
+ | ficheCount: … ,//Nombre total de fiches dans le groupe | ||
+ | ficheArray: [ //tableau des fiches (sa longueur peut être largement inférieure à ficheCount si le paramètre start est défini) | ||
+ | { // chaque fiche est un objet | ||
+ | __fichefields__ // série de propriétés définies par les paramètres fichefields ou fieldvariant | ||
+ | codemotcleArray: [...] // tableau des codes des mots-clés participant à la recherche et indexant la fiche (tableau d'entiers > 0), peut être étendu à tous les mots-clés indexant la fiche (voir les champs d'une fiche) | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | ], | ||
+ | motcleArray: [ // tableau des mots-clés, vide s'il n'y a aucun mot-clé | ||
+ | { | ||
+ | __motclefields__ // série propriétés définies par les paramètres motclefields ou fieldvariant | ||
+ | } | ||
+ | ], | ||
+ | engineInfo: {//objet identique à l'objet produit par type=engine (présent si le paramètre insert contient la valeur engineinfo) | ||
+ | … | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </code> | ||
+ | |||
+ | Version 1 et 2 : | ||
<code javascript> | <code javascript> | ||
Ligne 70: | Ligne 131: | ||
ficheArray: [ //tableau des fiches (sa longueur peut être largement inférieure à ficheCount si le paramètre start est défini) | ficheArray: [ //tableau des fiches (sa longueur peut être largement inférieure à ficheCount si le paramètre start est défini) | ||
{ // chaque fiche est un objet | { // chaque fiche est un objet | ||
- | __fichefields__ // série de propriétés définies par le paramètre fichefields | + | __fichefields__ // série propriétés définies par les paramètres fichefields ou fieldvariant |
codemotcleArray: [...] // tableau des codes des mots-clés participant à la recherche et indexant la fiche (tableau d'entiers > 0) | codemotcleArray: [...] // tableau des codes des mots-clés participant à la recherche et indexant la fiche (tableau d'entiers > 0) | ||
} | } | ||
Ligne 78: | Ligne 139: | ||
motcleArray: [ // tableau des mots-clés, vide s'il n'y a aucun mot-clé | motcleArray: [ // tableau des mots-clés, vide s'il n'y a aucun mot-clé | ||
{ | { | ||
- | __motclefields__ // série propriétés définies par le paramètre motclefields | + | __motclefields__ // série propriétés définies par les paramètres motclefields ou fieldvariant |
} | } | ||
], | ], | ||
Ligne 97: | Ligne 158: | ||
</code> | </code> | ||
- | ===== Version 0 ===== | + | Version 0 : |
<code javascript> | <code javascript> |