PATCH /player/update-player

version 2.0.0

Modifie une ou plusieurs informations d'un joueur 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
• Axel
• 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 du joueur
pseudo	string	Body	❌	Le pseudo du joueur
token	string	Body	❌	Token unique du joueur
gradeId	number	Body	❌	L'identifiant du grade à attribuer
credit	number	Body	❌	Nombre de crédits
modStatus	boolean	Body	❌	Statut modérateur
staff	bool	Body	❌	Si le joueur fait partie d'un des staffs
alert	bool	Body	❌	S'il veut voir les messages réservés aux staffs
nickname	string	Body	❌	Surnom du joueur
totalTimeConnection	number	Body	❌	Temps total de connexion
status	string	Body	❌	Statut actuel
ip	string	Body	❌	Adresse IP
discordId	string	Body	❌	ID Discord
langage	string	Body	❌	Langue
streamerPoint	number	Body	❌	Points stream
tag	string	Body	❌	Tag personnalisé
color	string	Body	❌	Couleur associée
highclub	boolean	Body	❌	Statut Highclub
vote	number	Body	❌	Le nombre de points de vote

info

Si vous souhaitez retirer le discordId, il faut mettre la valeur à "null" en string.

🧾 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 joueur sélectionné
pseudo	string	❌	Le pseudo du joueur sélectionné
credit	number	❌	Le nombre de crédits du joueur sélectionné
gradeId	number	❌	L'ID du grade du joueur sélectionné
modStatus	bool	❌	Si le joueur est en modérateur
staff	bool	❌	Si le joueur fait partie d'un des staffs
alert	bool	❌	S'il veut voir les messages réservés aux staffs
nickname	string	✅	Le surnom du joueur
status	string	❌	si le joueur est connecté au serveur
discordId	string	✅	Le discord ID s'il est relié
langage	string	❌	La langue du joueur
streamerPoint	number	❌	Le nombre de point de stream du joueur
tag	string	✅	Le grade custom a afficher
color	string	✅	La couleur custom a utiliser
highclub	bool	❌	Si le joueur possède le highclub
vote	number	❌	Le nombre de points de vote

📤 Exemple de requête

http://0.0.0.0/api/player/update-player

Et dans le body mettre par exemple pour changer le modStatus d'un joueur :

{
    "id" : 2,
    "modStatus" : true
}

📥 Exemple de réponse

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

{
    "id": 2,
    "pseudo": "Zeltaria",
    "credit": 0,
    "gradeId": 14,
    "modStatus": true,
    "staff": true,
    "alert": true,
    "nickname": "Zeltaria",
    "status": "Offline",
    "discordId": "213350119184138241",
    "langage": "FR",
    "streamerPoint": 0,
    "tag": null,
    "color": null,
    "highclub": true,
    "vote": 1
}

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

{
    "message": "Player not found",
    "code": 404
}