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_qfiche [2017/11/04 14:54] vincent [Paramètres communs optionnels] |
serveurscrutari:json:type_qfiche [2024/04/26 17:50] (Version actuelle) vincent |
||
|---|---|---|---|
| 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 48: | Ligne 48: | ||
| * //ponderation// : poids des différents facteurs dans le calcul de la pertinence (voir [[serveurscrutari:json:ponderation|Pondération de la pertinence]] | * //ponderation// : poids des différents facteurs dans le calcul de la pertinence (voir [[serveurscrutari:json:ponderation|Pondération de la pertinence]] | ||
| * //wildchar// : indique si une troncature doit être appliquée automatiquement (application d'un astérisque automatique au début ou à la fin du terme), les valeurs possibles sont //both//, //end// (valeur par défaut), //start// et //none// | * //wildchar// : indique si une troncature doit être appliquée automatiquement (application d'un astérisque automatique au début ou à la fin du terme), les valeurs possibles sont //both//, //end// (valeur par défaut), //start// et //none// | ||
| + | |||
| + | ==== Paramètres spéciaux ==== | ||
| + | * //log// : avec la valeur //always// (ou //all//), la recherche est toujours inscrite dans les journaux mais si une recherche identique a déjà été effectuée | ||
| + | * //store// : si la valeur est //no//, la recherche n'est pas stockée, aucun identifiant de recherche n'est créé | ||
| | | ||
| ===== 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 74: | Ligne 135: | ||
| 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 82: | Ligne 143: | ||
| 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 101: | Ligne 162: | ||
| </code> | </code> | ||
| - | ===== Version 0 ===== | + | Version 0 : |
| <code javascript> | <code javascript> | ||
