Aller au contenu principal

POST /sanction/create-sanction

version 2.0.0

Créer une nouvelle 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

Les champs suivants sont attendus dans le corps de la requête :

NomTypeDansRequisDescriptionValeur par default
sanctionTypestringbodyLe type de sanction
servernumberbodyL'id du server de la sanction
playerSanctionedIdstringbodyLe joueur sanctionner
adminIdstringbodyLe modérateur ayant appliquer la sanction
raisonstringbodyLa raison de la sanction
expirationstringbodyLa date de fin de sanction
datestringbodyLa date de création de la sanctioncurrentTimeStamp
activeboolbodySi la sanction est active

🧾 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
playerSanctionedIdnumberLe joueur sanctionner
adminIdnumberLe 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/create-sanction

Et dans le body mettre par exemple :

{
"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
}

📥 Exemple de réponse

Si la sanction est bien créé (code 201) :

{
"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
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
}