GET /player/get-players-with-badge

version 2.0.0

Récupère les joueurs ayant un certain badge.

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 de ces paramètres est requis (dans l'URL) pour identifier le joueur :

Nom	Type	Dans	Requis	Description	Valeur par default
badgeId	number	URL	✅	L'id du badge	❌

🧾 Réponse

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

Nom	Type	Nullable	Description
playerId	number	❌	L'ID du joueur sélectionné
playerPseudo	string	❌	Le pseudo du joueur
badgeId	number	❌	L'id du badge
badgeName	string	❌	Le nom du badge
badgeDescription	string	❌	La description du badge
badgeRarity	string	❌	La rareté du badge
badgeTexture	string	❌	Le chemin vers la texture du badge
badgeObtainable	bool	❌	Si le badge peut être obtenue par le joueur
dateObtained	string	❌	La date d'obtention du badge
active	bool	❌	Si le badge est visible sur le profil

📤 Exemple de requête

Si je souhaite chercher les informations du joueur d'id 2 voici ma requête :

http://0.0.0.0/api/player/get-players-with-badge?badgeId=2

📥 Exemple de réponse

Voici le retour de l'API en fonction du résultat :

Si tout va bien (code 200) :

[
    {
        "playerId": 2,
        "playerPseudo": "zeltaria",
        "badgeId": 1,
        "badgeName": "Amis des admins",
        "badgeDescription": "Avoir un admin en amie",
        "badgeRarity": "Epique",
        "badgeTexture": "badge/amie_des_admin.png",
        "badgeObtainable": false,
        "dateObtained": "2023-10-01T12:00:00Z",
        "active": true
    },
    {
        "playerId": 3,
        "playerPseudo": "axe1234567890689",
        "badgeId": 1,
        "badgeName": "Amis des admins",
        "badgeDescription": "Avoir un admin en amie",
        "badgeRarity": "Epique",
        "badgeTexture": "badge/amie_des_admin.png",
        "badgeObtainable": false,
        "dateObtained": "2023-10-01T12:00:00Z",
        "active": true
    }
]

info

Si aucun joueur 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 403 Forbidden :

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

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