Aller au contenu principal

GET /infecte/get-event

version 2.0.0

Récupérer les informations d’un event infecté.

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

Le paramètre suivant est requis dans l’URL pour identifier l'event :

NomTypeDansRequisDescriptionValeur par default
idnumberURLL'id de l'event

🧾 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-event?id=2

📥 Exemple de réponse

Si le joueur est trouvé (code 200) :

{
"id": 2,
"name": "Resistance",
"data": "{\"xp\":2, \"zombies\":5}"
}

⛔ 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 404 Not found :

Ici par exemple, l'erreur 404 signifie que le joueur n'a pas été trouvé dans la base de données.

{
"message": "No value present",
"code": 404
}