Aller au contenu principal

GET /infecte/get-planified-game

version 2.0.0

Récupérer les informations sur une partie planifiée.

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

Le paramètre suivant est requis dans l’URL pour identifier la partie planifiée :

NomTypeDansRequisDescriptionValeur par default
idnumberURLL'id de la partie

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id de la partie
eventIdnumberId de l'event
startAtstringHeure de départ de la partie
activebooleanSi la partie est active
mapIdnumberL'id de la map
scenarioIdnumberL'id des scenarios

📤 Exemple de requête

http://0.0.0.0/api/infecte/get-planified-game?id=2

📥 Exemple de réponse

Si la partie est trouvée (code 200) :

{
"id": 2,
"eventId": 1,
"startAt": "2025-10-12T10:00:00Z",
"active": false,
"mapId": 2,
"scenarioId": "{\"scenarioId1\": 2, \"scenarioId2\": 5}"
}

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

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