PATCH /sanction/update-sanction

version 2.0.0

Modifie une ou plusieurs 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

🧾 Paramètres

Tous les paramètres sont à envoyer dans le corps de la requête :

Nom	Type	Dans	Requis	Description
id	number	body	✅	L'id de la sanction
sanctionType	string	body	✅	Le type de sanction
server	number	body	✅	L'id du server de la sanction
playerSanctionedId	number	body	✅	Le joueur sanctionner
adminId	number	body	✅	Le modérateur ayant appliquer la sanction
raison	string	body	✅	La raison de la sanction
expiration	string	body	✅	La date de fin de sanction
date	string	body	❌	La date de création de la sanction
active	bool	body	✅	Si la sanction est active

🧾 Réponse

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

Nom	Type	Nullable	Description
id	number	✅	L'id de la sanction
sanctionType	string	✅	Le type de sanction
server	number	✅	L'id du server de la sanction
playerSanctionedId	number	✅	Le joueur sanctionner
adminId	number	✅	Le modérateur ayant appliquer la sanction
raison	string	✅	La raison de la sanction
expiration	string	✅	La date de fin de sanction
date	string	✅	La date de création de la sanction
active	bool	✅	Si la sanction est active

📤 Exemple de requête

http://0.0.0.0/api/sanction/update-sanction

{
    "id": 1,
    "active": false
}

📥 Exemple de réponse

Voici un exemple de réponse si la modification a été effectuée avec succès (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": false
}

⛔ 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 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
}