Aller au contenu principal

GET /sanction/get-sanction

version 2.0.0

Récupérer les informations d’une sanction.

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

🧾 Paramètres

Le paramètre suivant est requis dans l’URL pour identifier la sanction :

NomTypeDansRequisDescriptionValeur par default
idnumberURLL'id de la sanction

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id de la sanction
sanctionTypestringLe type de sanction
servernumberL'id du server de la sanction
playerSanctionedIdstringLe joueur sanctionner
adminIdstringLe modérateur ayant appliquer la sanction
raisonstringLa raison de la sanction
expirationstringLa date de fin de sanction
datestringLa date de création de la sanction
activeboolSi la sanction est active

📤 Exemple de requête

http://0.0.0.0/api/sanction/get-sanction?id=1

📥 Exemple de réponse

Si la sanction est trouvé (code 200) :

{
"id": 1,
"sanctionType": "MUTE",
"server": 1,
"playerSanctionedId": 7,
"adminId": 1,
"raison": "Disparue de la circulation",
"expiration": "2025-10-12T10:00:00Z",
"date": "2025-01-01T10:00:00Z",
"active": true
}

⛔ 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 la sanction n'a pas été trouvé dans la base de données.

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