Merge remote-tracking branch 'origin'

docs/ParametrageBulletins.md

@@ -99,10 +99,14 @@ Une balise supplémentaire est interprétée par ScoDoc pour insérer des logos
 Les logos sont des images au format JPEG (extension `.jpg` ou `.jpeg`) ou PNG (expension `.png`), téléversés sur le serveur scodoc et intégrables dans les documents html ou pdf.
 
 Principes généraux : 
+
 * Un logo est désigné par un identifiant (nom) et peut être défini soit globalement, soit pour un département;
+
 * le nom d'un logo est exclusiement composé de caractères alphanumériques ou du caractère '`-`';
-* les logos définis globalement sont accessibles pour tous les départements. Toutefois, si un logo de même nom est également dans un département,
-c'est le logo du département qui sera utilisé en lieu et place de logo global;
+
+* les logos définis globalement sont accessibles pour tous les départements. Toutefois, si un logo de même nom est également présent dans un département,
+, c'est le logo du département qui sera utilisé en lieu et place de logo global;
+
 * les logos de nom '`header`' et '`footer`' définis globalement ne peuvent être supprimés (mais peuvent être redéfinis).
 
 L'enregistrement, la modification ou la suppression d'un logo peut être réalisé via la page de configuration qui est accessible aux 
@@ -114,15 +118,16 @@ Une section présente la liste des logos avec leurs propriétés (la dimension e
 
 Pour chaque logo, les actions diponibles sont :
 
-* Le remplacement de l'image existante par un nouveau fichier
-* La suppression du logo (sauf pour `header`et `footer`dans la section globale)
+* Le remplacement de l'image existante par un nouveau fichier ;
 
-Il est également possible d'ajouter un nouveau logo dans une section (global ou département) et indiquant le nom.
+* la suppression du logo (sauf pour `header`et `footer`dans la section globale) ;
 
-*NB*. Quelquesoit l'opération effectuée, le nom du fichier téléversé n'a aucune importance
+* l'ajout d'un nouveau logo dans une section (global ou département) et indiquant le nom.
+
+*NB*. Quelle que soit l'opération effectuée, le nom du fichier téléversé n'a aucune importance
 (Seul le nom indiqué dans le formulaire est pris en compte et le format du fichier est déduit des données propres du fichier)
 
-La balise `<logo name="xxx" width="44mm" height="22mm" valign="+5mm"/>`, placée dans un paragraphe, insère alors le logo `xxx` avec les dimensions indiquées.
+La balise `<logo name="xxx" width="44mm" height="22mm" valign="+5mm"/>`, placée dans un paragraphe, insère le logo de nom `xxx` avec les dimensions indiquées.
 Le paramètre `valign` règle le positionnement vertical par rapport à la ligne de texte courante.
 
 Notez qu'il est possible de ne préciser que l'une des deux dimensions hauteur ou largeur. 

docs/ScoDoc9API.md

@@ -1172,6 +1172,44 @@ formsemestre_id": "SEM12345",
        ]
       ```
  
+## Logos
+
+  * **`liste des logos globaux`** 
+    * **Méthode:** GET
+    * **Paramètres:** `format` (json, xml), json par défaut
+    * **Route :** `/api/logos`
+    * **Exemple d'utilisation :** `/api/logos?format=xml`
+    * **Résultat :** Liste des logos définis pour le site scodoc.
+    * **Exemple de résultat:** `['header', 'footer', 'custom']`
+
+
+
+  * **'récupération d'un logo global'** 
+    * **Méthode:** GET
+    * **Paramètres :** Aucun
+    * **Route: `/api/logos/<str:nom>`
+    * **Exemple d'utilisation :** `/api/logos/header`
+    * **Résultat :** l'image (format png ou jpg)
+    
+
+
+  * **`logo d'un département`** 
+    * **Méthode:** GET
+    * **Paramètres:** `format` (json, xml)
+    * **Route :** `/api/departements/<str:dept>/logos`
+    * **Exemple d'utilisation :** `/api/MMI/logos`
+    * **Résultat :** Liste des logos définis pour le département visé.
+    * **Exemple de résultat:** `['footer', 'signature', 'universite']`
+
+
+
+  * **'récupération d'un logo global'** 
+    * **Méthode:** GET
+    * **Paramètres :** Aucun
+    * **Route: `/api/departements/<str:dept>/logos/<str:nom>`
+    * **Exemple d'utilisation:** `/api/departements/MMI/logos/header`
+    * **Résultat :** l'image (format png ou jpg)
+    
 
 
 ##  En savoir plus