Aller au contenu principal

GET /form/get-form

version 2.0.0

Récupérer les informations d’une réponse au formulaire.

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
  • Site

🧾 Paramètres

Le paramètre suivant est requis dans l’URL pour identifier le badge :

NomTypeDansRequisDescriptionValeur par default
idnumberURLL'id de la réponse

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id de la réponse
playerIdnumberL'id du player qui a répondue
videostringun lien vers une vidéo
question1stringLa réponse du joueur pour la 1e question
question2stringLa réponse du joueur pour la 2e question
question3stringLa réponse du joueur pour la 3e question
question4stringLa réponse du joueur pour la 4e question
question5stringLa réponse du joueur pour la 5e question
stage1boolSi le joueur a passer la 1e palier
stage2boolSi le joueur a passer la 2e palier
stage3boolSi le joueur a passer la 3e palier
commentboolPour rajouter un commentaire

📤 Exemple de requête

http://0.0.0.0/api/packs/get-form?id=2

📥 Exemple de réponse

Si la réponse est trouvé (code 200) :

{
"id" : 2,
"playerId": 2,
"video": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"question1": "Never gonna give you up",
"question2": "Never gonna let you down",
"question3": "Never gonna run around and desert you",
"question4": "Never gonna make you cry",
"question5": "Never gonna say good bye",
"stage1": null,
"stage2": null,
"stage3": null,
"comment": "Never gonna tell a lie and hurt you"
}

⛔ 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 réponse avec pour id : '2' n'a pas été trouvé dans la base de données.

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