Différences

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

--- serveurscrutari:json:type_enginegroup [2016/09/27 15:22]
vincent créée
+++ serveurscrutari:json:type_enginegroup [2017/11/05 15:08] (Version actuelle)
vincent [Objet retourné]
@@ Ligne 1: / Ligne 1: @@
 ====== type = enginegroup ======
-Cette requête JSON donne les informations concernant un groupe de moteurs. Un groupe de moteurs est défini au niveau de l'instance de Scrutari elle-même (voir les [[serveurscrutari:config:group|groupes de moteur]]). Cette requête a ceci de particulier qu'elle peut être invoquée à la même adresse que les autres mais aussi par le lien plus court {adresse de l'instance}/_json.
+Cette requête JSON donne les informations concernant un groupe de moteurs. Un groupe de moteurs est défini au niveau de l'instance de Scrutari elle-même (voir les [[serveurscrutari:config:group|groupes de moteur]]).
+Une particularité de cette requête, c'est qu'elle peut être invoquée de trois manières différentes :
+  * via l'adresse normale {adresse de l'instance}/{nom du moteur}/_json
+  * via l'accès direct au serveur {adresse de l'instance}/_json
+  * via l'accès par le groupe {adresse de l'instance}/_groups/{nom du groupe}/json
+Les informations d'un moteur sont celles des méta-données (voir le [[serveurscrutari:config:metadata|fichier metadata.xml]]).
@@ Ligne 9: / Ligne 17: @@
   * //version// : version à utiliser (Version actuelle : 1)
-  *
 ==== Paramètres communs optionnels ====
@@ Ligne 16: / Ligne 24: @@
 ==== Paramètres spécifiques obligatoires ====
-  * //name// : nom du groupe
+  * //name// : nom du groupe, ce paramètre n'est pas nécessaire dans le cas de l'accès par {adresse de l'instance}/_groups/{nom du groupe}/json
 ==== Paramètres spécifiques optionnels ====
@@ Ligne 24: / Ligne 32: @@
 ===== Objet retourné =====
+Versions 3 et 2
 <code javascript>
 {
   engineGroup: {
+    name: … ,//nom du groupe
+    title: … ,//titre du groupe
+    attrMap: { // tableau associatif des attributs du groupe
+      (clé): [ // la clé est celle de l'attribut
+        … //valeurs de l'attribut
+       ]
+    },
+    engineArray: [ //tableau des moteurs
+      {
+        name: … ,//nom du moteur du moteur
+        url: … ,//adresse du moteur
+        title: … ,//titre du moteur
+        phraseMap: { // tableau associatif des intitulés associés à la catégorie
+          (nom): … , // nom de l'intitulé auquel correspond sa valeur (chaine)
+        },
+        icon: … ,//icone du moteur
+        website: … ,//site de référence du moteur
+        attrMap: { // tableau associatif des attributs du moteur
+          (clé): [ // la clé est celle de l'attribut
+            … //valeurs de l'attribut
+           ]
+        }
+      }
+    ]
   }
 }
+</code>
+Version 1
+<code javascript>
+{
+  engineGroup: {
+    name: … ,//nom du groupe
+    title: … ,//titre du groupe
+    attrMap: { // tableau associatif des attributs du groupe
+      (clé): [ // la clé est celle de l'attribut
+        … //valeurs de l'attribut
+       ]
+    },
+    engineArray: [ //tableau des moteurs
+      {
+        name: … ,//nom du moteur du moteur
+        url: … ,//adresse du moteur
+        title: … ,//titre du moteur
+        description: … ,//description courte du moteur
+        icon: … ,//icone du moteur
+        website: … ,//site de référence du moteur
+        attrMap: { // tableau associatif des attributs du moteur
+          (clé): [ // la clé est celle de l'attribut
+            … //valeurs de l'attribut
+           ]
+        }
+      }
+    ]
+  }
+}
 </code>