Aller au contenu principal

GET /code/get-player-used-codes

version 2.0.0

Récupère tous les codes que le joueur a utilisé.

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

Un seul paramètre est requis dans l'URL :

NomTypeDansRequisDescriptionValeur par default
playerIdstringURLL'identifiant du joueur

🧾 Réponse

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

NomTypeNullableDescription
playerIdnumberL'identifiant du joueur
codeIdnumberL'identifiant du code

📤 Exemple de requête

Voici un exemple pour récupérer les codes utilisés par un joueur :

http://0.0.0.0/api/code/get-player-used-codes?playerId=1

📥 Exemple de réponse

Si des codes sont trouvés, la réponse (code 200) sera :

[
{
"playerId" : 1,
"codeId" : 1
},
{
"playerId" : 1,
"codeId" : 5
}
]
info

Si aucun codes n'est trouvé pour le joueur, 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 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas accès à cette requête.

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