Aller au contenu principal

PATCH /minigame/update-server

version 2.0.0

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

🧾 Paramètres

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

NomTypeDansRequisDescription
idstringBodyL'id du server
gamestringBodyLe nom du jeu du server
ownerIdnumberBodyL'id du joueur qui a créer le host
whiteliststringBodyLes joueurs qui sont whitelist (null si public)
statusstringBodyLe status du server

🧾 Réponse

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

NomTypeNullableDescription
idstringL'id du server
gamestringLe nom du jeu du server
ownerIdnumberL'id du joueur qui a créer le host
whiteliststringLes joueurs qui sont whitelist (null si public)
statusstringLe status du serveur

📤 Exemple de requête

http://0.0.0.0/api/minigame/update-server

Et dans le body mettre par exemple pour changer les joueurs de la whitelist:

{
"id" : "GolemRush-5212",
"whitelist" : "Zeltaria, Tahyme"
}

📥 Exemple de réponse

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

{
"id": "GolemRush-5212",
"game": "GolemRush",
"ownerId": 43,
"whitelist": "Zeltaria, Tahyme",
"status": "public"
}

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

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