Aller au contenu principal

PATCH /booster/update-booster

version 2.0.0

Modifie une ou plusieurs informations d'un booster 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 :

NomTypeDansRequisDescription
idnumberURLL'id du grade
serverIdnumberBodyL'id du server bénéfician du booster
multipliernumberBodyLa puissance du booster
hourstringBodyl'heure de l'activation du booster (a laisser par défaut)
activatedboolBodySi le booster est activé

🧾 Réponse

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

NomTypeDansNullableDescription
idnumberBodyL'id du booster
serverIdnumberBodyL'id du server bénéfician du booster
multipliernumberBodyLa puissance du booster
hourstringBodyl'heure de l'activation du booster (a laisser par défaut)
activatedboolBodySi le booster est activé

📤 Exemple de requête

http://0.0.0.0/api/booster/update-booster

Et dans le body mettre par exemple :

{
"id": 1,
"activated": 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,
"serverId": 1,
"multiplier": 5,
"hour": "2023-10-01T12:00:00Z",
"activated": false
}

⛔ 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
404Not foundEntité introuvable
409ConflictConflit avec des données existantes
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 404 Not found :

Ici par exemple, l'erreur 404 signifie que le booster n'a pas été trouvé dans la base de données.

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