POST /infecte/setup-settings

version 2.0.3

Setup les settings d'un joueur.

Authentification

Cette route nécessite de mettre votre clé API dans le Header.

👥 Autorisation

Les personnes autorisées pour utiliser cette requête sont :

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

Nom	Type	Dans	Requis	Description	Valeur par default
`playerId`	number	body	✅	L'id du joueur	❌
`rate`	bool	body	❌	Si on affiche le gui de vote	true
`achievementSound`	bool	body	❌	Si on diffuse le son des achievements	true
`scoreboard`	bool	body	❌	Si on affiche le scoreboard	true
`weather`	string	body	❌	La météo de la map	null
`chestplate`	string	body	❌	La couleur du plastron	null

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

Nom	Type	Nullable	Description
`playerId`	number	❌	L'id du joueur
`rate`	bool	❌	Si on affiche le gui de vote
`achievementSound`	bool	❌	Si on diffuse le son des achievements
`scoreboard`	bool	❌	Si on affiche le scoreboard
`weather`	string	✅	La météo de la map
`chestplate`	string	✅	La couleur du plastron

http://0.0.0.0/api/infecte/setup-settings

Et dans le body mettre par exemple :

{
    "playerId": 2
}

Si les settings est bien créé (code 201) :

{
    "playerId": 2,
    "rate": true,
    "achievementSound": true,
    "scoreboard": true,
    "weather": null,
    "chestplate": null
}

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
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 401 Unauthorized :

Ici par exemple, l'erreur 401 signifie que vous n'avez pas la permission nécessaire pour cette requête.

{
    "message": "Access Denied",
    "code": 401
}