Aller au contenu principal

GET /infecte/get-players-with-achievement

version 2.0.0

Récupérer les informations des joueurs qui ont obtenu un achievement donné.

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
  • Site

🧾 Paramètres

Le paramètre suivant est requis dans l’URL pour identifier le joueur :

NomTypeDansRequisDescriptionValeur par default
achievementIdnumberURLL'id de l'achievement

🧾 Réponse

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

NomTypeNullableDescription
playerIdnumberL'id du joueur
achievementIdnumberL'id de l'achievement
dateObtentionstringL'heure d'obtention de l'achievement

📤 Exemple de requête

http://0.0.0.0/api/infecte/get-players-with-achievement?achievementId=3

📥 Exemple de réponse

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

[
{
"playerId": 3,
"achievementId": 3,
"dateObtention": "2023-10-01T12:00:00Z"
},
{
"playerId": 9,
"achievementId": 3,
"dateObtention": "2023-12-01T05:29:00Z"
}
]
info

Si aucun joueurs n'est trouvé pour l'achievement, 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
}