Aller au contenu principal

PATCH /infecte/update-map

version 2.0.0
Authentification

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

Modifie une ou plusieurs informations d'une map.

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
idnumberbodyL'id de la map
mapNamestringbodyNom de la map
winZnumberbodyLe nombre de win en tant que zombie
winHnumberbodyLe nombre de win en tant qu'humain
displayNamestringbodyLe nom d'affichage de la map
authorstringbodyL'auteur de la map
minPlayernumberbodyLe nombre minimum de joueurs
maxPlayernumberbodyLe nombre maximum de joueurs
spawnZombiestringbodyLes coordonnées du spawn Zombie
spawnHumanstringbodyLes coordonnées du spawn Humain

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id de la map
mapNamestringNom de la map
winZnumberLe nombre de win en tant que zombie
winHnumberLe nombre de win en tant qu'humain
displayNamestringLe nom d'affichage de la map
authorstringL'auteur de la map
minPlayernumberLe nombre minimum de joueurs
maxPlayernumberLe nombre maximum de joueurs
spawnZombiestringLes coordonnées du spawn Zombie
spawnHumanstringLes coordonnées du spawn Humain

📤 Exemple de requête

http://0.0.0.0/api/infecte/update-map

Et dans le body mettre par exemple pour changer le nombre de victoire des zombies :

{
"id": 2,
"winZ": 1
}

📥 Exemple de réponse

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

{
"id": 2,
"mapName": "lonely town",
"winZ": 1,
"winH": 0,
"displayName": "Lonely Town",
"author": "NokoShizen",
"minPlayer": 2,
"maxPlayer": 15,
"spawnZombie": "{\"x\":120, \"y\":64, \"z\":-516}",
"spawnHuman": "{\"x\":110, \"y\":65, \"z\":-681}"
}

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

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