GET /infecte/get-scenarios

version 2.0.0

Récupérer tous les scenarios.

Authentification

Cette route nécessite de mettre votre clé API dans le Header.

👥 Autorisation

Les personnes autorisées pour utiliser cette requête sont :

• Corail
• Zelta

🧾 Paramètres

Cette requête ne prend pas de paramètre

🧾 Réponse

Les données que l'API retournera avec le succès de la requête :

Nom	Type	Nullable	Description
id	number	❌	L'id du scenario
name	string	❌	Le nom du scenario
displayName	string	❌	Le nom affiché du scenario
description	string	✅	La description
minPlayer	number	❌	Le nombre minimum de joueur pour déclencher ce scenario
maxPlayer	number	❌	Le nombre maximum de joueur pour déclencher ce scenario

📤 Exemple de requête

http://0.0.0.0/api/infecte/get-scenarios

📥 Exemple de réponse

Si des scenarios sont trouvées (code 200) :

[
    {
        "id": 2,
        "name": "swap",
        "displayName": "swap",
        "description": "échange les positions des joueurs entre eux",
        "minPlayer": 2,
        "maxPlayer": 30
    }
]

info

Si aucun scénario n'est trouvé, l'API retourne un tableau vide.

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTP	Description	Cause possible
400	Bad Request	Paramètres manquants ou invalides
401	Unauthorized	Clé API manquante ou invalide
403	Forbidden	Droits insuffisants pour utiliser la requête
404	Not found	Entité introuvable
500	Internal Server Error	Erreur interne du serveur

Attention !

En cas d'erreur 500, contactez directement Zeltaria avec votre requête, sa réponse ainsi que toutes informations que vous jugez pertinentes !

En cas d'erreur voici les informations que retourne l'API

Nom	Type	Description
code	number	Le code d'erreur que retourne la requête
message	string	Le message de l'API expliquant l'erreur

Exemple avec l'erreur 401 Unauthorized :

Ici par exemple, l'erreur 401 signifie que vous n'avez pas la permission nécessaire pour cette requête.

{
    "message": "Access Denied",
    "code": 401
}