API - Référentiels
Récupérez les référentiels de Quiz API
Cet endpoint vous permet de récupérer les référentiels l'application afin de, par exemple, pouvoir dynamiquement afficher à vos utilisateurs les différentes difficultés ou les thèmes de l'application avec les dernières infos de la dernières mise à jour du logiciel.
Même si les modifications de référentiels seront extrêmement rares, Il est conseillé de récupérer ces informations à chaque mise à jour de l'application Quiz, ou plus simplement, de les récupérer une fois par mois via tâche automatisée puis de les insérer en base de données ou cache local.
# Référentiel Thème
# Endpoint
- URL
- /api/referential/themes
- Méthode HTTP
- GET
- Description
- Récupère la liste des des Thèmes de l'application avec leur traduction.
GET /api/referential/themes
Authorization: Bearer [your-access-token]
Accept: application/json
Content-Type: application/json
# Exemple de Réponse
HTTP/1.1 200 OK Content-Type: application/json { "data": [ { "title": "Culture Générale", "code": "cg" }, { "title": "Géographie & Géopolitique", "code": "geo" }, { "title": "Histoire", "code": "hist" }, { "title": "Astronomie", "code": "astro" }, { "title": "Arts", "code": "art" }, { "title": "Sciences & Technologie", "code": "sci" }, { "title": "Biologie & Nature", "code": "bio" }, { "title": "Sport", "code": "sp" }, { "title": "Cuisine et Gastronomie", "code": "cui" }, { "title": "Mythologie", "code": "myth" } ] }
# Paramètres
Pas de paramètres
# Référentiel Difficultés
# Endpoint
- URL
- /api/questions/difficulties
- Méthode HTTP
- GET
- Description
- Récupère la liste des Difficultés sous forme de nombre.
1 étant la difficulté la plus faible.
GET /api/referential/questions/difficulties
Authorization: Bearer [your-access-token]
Accept: application/json
Content-Type: application/json
# Exemple de Réponse
HTTP/1.1 200 OK Content-Type: application/json { "data": [ 1, 2, 3, 4, 5, 6 ] }
# Paramètres
Pas de paramètres
# Référentiel Types de Questions
# Endpoint
- URL
- /api/questions/types
- Méthode HTTP
- GET
- Description
- Récupère la liste des Types de questions.
GET /api/referential/questions/types
Authorization: Bearer [your-access-token]
Accept: application/json
Content-Type: application/json
# Exemple de Réponse
HTTP/1.1 200 OK Content-Type: application/json { "data": [ "solo", "multi", "pattern" ] }
# Paramètres
Pas de paramètres
# Types de Questions
- solo
- Questions à choix multiples avec une unique réponse possible.
- multi
- Questions à choix multiples avec plusieurs réponses disponibles.
- pattern
- Question à choix libre, l'utilisateur tapera une réponse sur son clavier et une REGEX vérifiera sa réponse.
- image
- (soon ...) Question avec une image
- sort
- (soon ...) Question à trier du plus petit au plus grand (dates, poids, tailles)