From e179139f87fcc8be7f5737fafb9afa63175f7a7a Mon Sep 17 00:00:00 2001 From: Jean-Marie PLACE Date: Mon, 20 Dec 2021 17:44:45 +0100 Subject: [PATCH] ajout api logos --- docs/ScoDoc9API.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 9164d50..89a88f8 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -1169,6 +1169,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/` + * **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//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//logos/` + * **Exemple d'utilisation:** `/api/departements/MMI/logos/header` + * **Résultat :** l'image (format png ou jpg) + ## En savoir plus