PATCH /grade/update-grade

version 2.0.0

Modifie une ou plusieurs informations d'un grade existant.

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

🧾 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 du grade
name	string	Body	❌	Le nom du grade à créer
prefix	string	Body	❌	Préfixe pour afficher le grade
reducedPrefix	string	Body	❌	Préfixe pour afficher le grade sans la couleur
power	string	Body	❌	Le niveau d'autorisation du grade
color	string	Body	❌	La couleur du grade

Power

Le champ power doit forcément être plus grand que 0.

🧾 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 du grade
name	string	❌	Le nom du grade à créer
prefix	string	❌	Préfixe pour afficher le grade
reducedPrefix	string	❌	Préfixe pour afficher le grade sans la couleur
power	string	❌	Le niveau d'autorisation du grade
color	string	❌	La couleur du grade

📤 Exemple de requête

http://0.0.0.0/api/grade/update-grade

Et dans le body mettre par exemple pour changer le préfix réduit d'un grade :

{
    "id": 1,
    "reducedPrefix": "§r乖"
}

📥 Exemple de réponse

Voici un exemple de réponse si la modification a été effectuée avec succès (code 200) :

{
    "id": 1,
    "name": "Joueur",
    "prefix": "§r乖 {Hexa#686868}",
    "reducedPrefix": "§r乖",
    "power": 1,
    "color": "{Hexa#686868}"
}

info

Si vous modifier la color ou le reducedPrefix n'oubliez pas de mettre à jour le prefix.

⛔ 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
409	Conflict	Conflit avec des données existantes
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 le grade n'a pas été trouvé dans la base de données.

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