ScoDoc/DocScoDoc
7
2
Fork 10
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

ajout api logos

Browse Source
This commit is contained in:
Jean-Marie PLACE 2021-12-20 17:44:45 +01:00
parent 18ca7429a7
commit e179139f87
1 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/ScoDoc9API.md
View File

@ -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/<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 ## En savoir plus