type = q-fiche

Cette requête JSON est la requête principale de Scrutari car c'est elle qui permet de faire une recherche sur les fiches. Elles retournent toutes les fiches ainsi que tous les mots-clés qui ont servi à la recherche.

Paramètres

Paramètres communs obligatoires

  • q : séquence de recherche (est ignoré si q-id est indiqué)

Paramètres communs optionnels

  • langui : langue à utiliser de préférence pour les intitulés
  • corpuslist : limitation de la recherche à des corpus déterminés
  • langlist : limitation de la recherche aux fiches dans des langues déterminées
  • start : point de départ des fiches retournées, s'il y a plusieurs groupes de fiches, le point de départ est évaluée par rapport à l'ordre global des fiches (si il y a 15 fiches dans un premier groupe et 40 dans un second groupe, le point de départ 20 correspond à la cinquième fiche du second groupe
  • limit : limite du nombre de fiches retournées
  • fichefields : champs qui se retrouveront dans les objets du tableau ficheArray (voir Champs des fiches)
  • motclefields : champs qui se retrouveront dans les objets du tableau motcleMap (voir Champs des mots-clés)

Paramètres spécifiques obligatoires

  • q-id : au lieu du paramètre q, il est possible d'indiquer l'identifiant du recherche déjà effectuée (afin, par exemple de récupérer l'information sur une plage de fiches). q et q-id sont mutuellement excluants (q-id ayant la préséance sur q), autrement dit c'est la présence de l'un des deux qui est obligatoire.

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
  • log : indique si la trace de la recherche doit être conservée ou non (valeur 0 ou 1)
  • remote : adresse IP à l'origine de la recherche
  • site : site d'où est parti la recherche
  • referrer : page d'où est parti la recherche
  • indexation : fait un filtre initial sur des mots-clés, sa syntaxe est précisée dans Filtre d'indexation

Objet retourné

{
  ficheSearchResult: {
    q:, //séquence de recherche (chaine)
    qId:, //identifiant de la recherche (chaine)
    qLength:, //longueur de la séquence de recherche (i.e. nombre de composants de la séquence) (entier >= 0)
    qSource:, // chaine originale de la recherche transmise par l'internaute (chaine)
    langUi:, //rappel de la langue de préférence pour l'interface (optionnel, absent si non défini dans la requête initiale) (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
    completeMotcleCount:, //nombre de mots-clés contenant tous les composants de la séquence de recherche
    ficheGroupType:, // type de groupement des fiches, prend la valeur "corpusclasse" (regroupement par classe de corpus) ou "none" (pas de classe de corpus)
    ficheGroupArray: [ //tableau des groupes de fiches répondant aux critères de recherche, les groupes sont basés sur les classes de corpus (s'il n'y a pas de classe, il y a un seul groupe), absent si aucune fiche
      { // chaque groupe de fiches est un objet
        corpusClasse:  { // objet décrivant la classe de corpus du groupement, présent uniquement si ficheGroupType="corpusclasse"
        {
          rank:, // rang de la classe (entier > 0)
          name:, // nom de la classe (chaine)
          intitule:// intitulé de la classe dans la langue d'interface (chaine)
        },
        ficheArray: [ //tableau des fiches
          { // chaque fiche est un objet
            __fichefields__ // série de propriétés définies par le paramètre fichefields
            codemotcleArray: [...] // tableau des codes des mots-clés participant à la recherche et indexant la fiche (tableau d'entiers > 0)
          }
        ]
      }
    ],
    motcleArray: [ // tableau des mots-clés, absent si aucun mot-clé
      {
        __motclefields__ // série propriétés définies par le paramètre motclefields
      }
    ],
    corpusIntituleArray: [ // tableau des intitulés de corpus, si le paramètre intitule est défini
      {
        codecorpus:, // code du corpus (entier > 0)
        corpus:, // intitulé du corpus (chaine)
        fiche:, // intitulé d'une fiche (chaine)
        complement_XXX:// intitulé du complément de numéro XXX
      }
    ]
  }
}
serveurscrutari/json/type_qfiche.txt · Dernière modification: 2011/10/04 20:34 par vincent
CC Attribution-Noncommercial-Share Alike 3.0 Unported
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0