Aller au contenu principal

GET /infecte/get-events

version 2.0.0

Récupérer les informations des events.

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 :

NomTypeNullableDescription
idnumberL'id de l'event
namestringLe nom de l'event
datastringLes données de l'event

📤 Exemple de requête

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

📥 Exemple de réponse

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

[
{
"id": 2,
"name": "Resistance",
"data": "{\"xp\":2, \"zombies\":5}"
},
{
"id": 3,
"name": "Speed",
"data": "{\"xp\":2, \"speed\":3}"
}
]
info

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

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTPDescriptionCause possible
400Bad RequestParamètres manquants ou invalides
401UnauthorizedClé API manquante ou invalide
403ForbiddenDroits insuffisants pour utiliser la requête
404Not foundEntité introuvable
500Internal Server ErrorErreur 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

NomTypeDescription
codenumberLe code d'erreur que retourne la requête
messagestringLe 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 les permissions nécessaires pour cette requête.

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