Aller au contenu principal

GET /minigame/get-grades

version 2.0.2

Récupérer les informations de tous les grades minigame.

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

🧾 Paramètres

Aucun paramètre n'est requis pour cette requête.

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id du grade
namestringLe nom du grade à créer
prefixstringPréfixe pour afficher le grade
reducedPrefixstringPréfixe pour afficher le grade sans la couleur
colorstringLa couleur du grade

📤 Exemple de requête

http://0.0.0.0/api/minigame/get-grades

📥 Exemple de réponse

Si des grades sont trouvés (code 200) :

[
{
"id": 1,
"name": "Joueur",
"prefix": "§r乖 {Hexa#686868}",
"reducedPrefix": "§r乖",
"color": "{Hexa#686868}"
},
{
"id": 2,
"name": "Modérateur",
"prefix": "§r亀 {Hexa#7674E0}",
"reducedPrefix": "§r亀",
"color": "{Hexa#7674E0}"
}
]
info

Si aucun grade 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
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 les droits pour cette requête.

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