Update Api

ynerant 2020-04-02 16:08:51 +02:00
parent d87f64cb99
commit 9faf15b4b8
1 changed files with 28 additions and 1 deletions

@ -1,3 +1,30 @@
# API # API
La NoteKfet2020 dispose d'une API REST. Elle est accessible sur `/api/`. La NoteKfet2020 dispose d'une API REST. Elle est accessible sur `/api/`. Elle supporte les requêtes GET, POST, HEAD, PUT, PATCH et DELETE (peut varier selon les pages).
## Pages de l'API
Il suffit d'ajouter le préfixe `/api/` pour arriver sur ces pages.
* `models` (liste des différents modèles enregistrés en base de données)
* `user` (liste des différents utilisateurs enregistrés)
* `members/profile` (liste des différents profils associés à des utilisateurs)
* `members/club` (liste des différents clubs enregistrés)
* `members/role` (liste des différents rôles au sein des clubs existant)
* `members/membership` (liste des adhésions enregistrées)
* `activity/activity` (liste des activités recensées)
* `activity/type` (liste des différents types d'activités : pots, soirées de club, ...)
* `activity/guest` (liste des personnes invitées lors d'une activité)
* `activity/entry` (liste des entrées effectuées lors des activités)
* `note/note` (liste des notes enregistrées)
* `note/alias` (liste des alias enregistrés)
* `note/transaction/category` (liste des différentes catégories de boutons : soft, alcool, ...)
* `note/transaction/transaction` (liste des transactions effectuées)
* `note/transaction/template` (liste des boutons enregistrés)
* `treasury/invoice` (liste des factures générées)
* `treasury/product` (liste des produits associés à des factures)
* `treasury/remittance_type` (liste des types de remises supportés : chèque)
* `treasury/remittance` (liste des différentes remises enregistrées)
* `permission/permission` (liste de toutes les permissions enregistrées)
* `permission/roles` (liste des permissions octroyées pour chacun des rôles)
* `logs` (liste des modifications enregistrées en base de données)