Différences

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

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
serveurscrutari:json:type_fiche [2011/03/18 11:26]
vincent
serveurscrutari:json:type_fiche [2022/07/06 16:39] (Version actuelle)
vincent
Ligne 1: Ligne 1:
 ====== type = fiche ====== ====== type = fiche ======
  
-Cette requête JSON permet de récupérer une liste de fiches suivant certains critères.+Cette requête JSON permet de récupérer une liste de fiches suivant certains critères. Si le paramètre //​fichelist//​ est utilisé, les autres paramètres sont ignorés, sinon ce sont des paramètres équivalents à ceux la recherche de fiches. Si aucun paramètre n'est indiqué, la requête renvoie l'​intégralité des fiches.
  
-Cette requête possède un paramètre obligatoire,​ //mode// qui indique le mode de filtre utilisé pour sélectionner. Chaque mode introduit ses propres paramètres qui sont décrits ci-après. Les modes sont les suivants :+===== Paramètres =====
  
-  * //motcle// : fait un filtre suivante des mots-clés. indique le mode de filtre utilisé pour sélectionner les fiches. Ce mode possède un paramètre obligatoire : +==== Paramètres communs obligatoires ==== 
-    * //motcle// : liste des codes ou des URI (séparé par une virguledes mots-clés. qui servent de filtres+  * //version// : version à utiliser ​(Version actuelle : 3)
  
  
-Cette requête possède également un paramètre optionnel //prop// qui permet d'​indiquer les propriétés qui se retrouveront dans l'​objet JSON. La description complète de ce paramètre se trouve sur la page [[serveurscrutari:​json:​fiche_fields|Champs des fiches]].+==== Paramètres communs optionnels ====
  
-Enfin, il est conseillé ​d'indiquer ​la langue ​d'interface avec le paramètre ​//langui//.+ 
 +  * //lang// : langue à utiliser de préférence pour les intitulés 
 +  * //​langlist//​ : limitation des fiches à certaines langues (ignoré si //​fichelist//​ est défini) 
 +  * //​baselist//​ : limitation des fiches à certaines bases (ignoré si //​fichelist//​ est défini) 
 +  * //​corpuslist//​ : limitation des fiches à certains corpus (ignoré si //​fichelist//​ est défini) 
 +  * //​categorylist//​ : limitation des fiches aux corpus appartenant aux catégories indiquées (ignoré si //​fichelist//​ est défini) 
 +  * //​fichefields//​ : détermine les champs à transmettre (voir [[serveurscrutari:​json:​fiche_fields|Champs des fiches]])si le paramètre contient //​codemotclearray//,​ les mots-clés indexant la fiche sont également transmis 
 +  * //​fieldvariant//​ : variante de champs à utiliser (voir le fichier [[serveurscrutari:​config:​fields|fields.xml]] et [[serveurscrutari:​json:​fiche_fields|Champs des fiches]]) (ignoré si //​fichefields//​ est défini) 
 + 
 +==== Paramètres spécifiques optionnels ==== 
 + 
 +  * //​fichelist//​ : liste de codes de fiches, s'il est présent les autres paramètres sont ignorés 
 +  * //flt// (//flt-*//) : filtres établissant la sélection de fiches (voir [[serveurscrutari:​json:​filtersyntax|Syntaxe des filtres]]) 
 +  * //ignore// : la valeur //​alternate//​ indique que les fiches qui sont des traductions ​d'autres fiches également sélectionnées (et dans la langue ​principales) sont ignorées 
 +  * //insert// : la valeur //​motclearray//​ indique qu'il faut ajouter ​le tableau des mots-clés dont les codes seront dans //codemotcleArray// d'une fiche, l'​argument n'est pas pris en compte si //​codemotcleArray//​ ne fait pas partie des champs d'une fiche 
 +  * //random// : vaut - 1 ou un entier strictement positif, indique le nombre de fiches qu'il faut conserver après les filtres, ces fiches sont sélectionnées aléatoirement ; si la valeur est -1, toutes les fiches sont retournées classées de façon aléatoire
  
  
 ===== Objet retourné ===== ===== Objet retourné =====
 +
 +Version 3 et 2 :
  
 <code javascript>​ <code javascript>​
 { {
-  ​dataFiche+  ​ficheArray// tableau des fiches 
-    count: (nombre total fiche), +     ​{ // chaque ​fiche est un objet 
-    infoMap: ​ { //Objet contenant les fiches ​sous forme de propriétés (dont le nom est c + code de la fiche +         __fiche-fields__ ​// série ​de propriétés définies par le paramètre ​fichefields
-       cXXX: { //XXX est le code de la fiche est un objet avec les propriétés suivantes : +
-           cdfch: … , //code de la fiche (entier > 0) +
-           ​cdcrp:​ … , //code du corpus (entier > 0) +
-           id: …, //partie Fiche-id de l'URI de la fiche (chaine) +
-           -- fiche-fields -- // partie optionnelle en fonction du paramètre ​fiche-fields +
-       }, +
-       ...+
      }      }
 +  ],
 +  motcleArray : [ // tableau des mots-clés si insert=motcleArray
 +     { // chaque mot-clé est un objet
 +     ... // construit de manière identique à motcleArray de type=motcle
 +     }
 +}
 +
 +</​code>​
 +
 +Version 1 (//​ficheArray//​ était encapsulé dans un objet //​ficheData//​) : 
 +
 +<code javascript>​
 +{
 +  ficheData: {
 +    ficheCount: … , //(nombre total de fiches),
 +    ficheArray: [ // tableau des fiches
 +       { // chaque fiche est un objet
 +           ​__fiche-fields__ // série de propriétés définies par le paramètre fichefields,​
 +           ​codemotcleArray:​ [...] // tableau des codes des mots-clés indexant la fiche (tableau d'​entiers > 0), si codemotclearray est indiqué dans fichefields ou dans la variante précisée par  fieldvariant
 +       }
 +     ]
   }   }
 } }
serveurscrutari/json/type_fiche.1300443981.txt.gz · Dernière modification: 2011/03/18 11:26 par vincent
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0