POST /form/create-form

version 2.0.0

Rajoute une réponse de 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

Les champs suivants sont attendus dans le corps de la requête :

Nom	Type	Dans	Requis	Description	Valeur par default
playerId	number	Body	✅	L'id du player qui a répondue	❌
video	string	Body	✅	un lien vers une vidéo	❌
question1	string	Body	✅	La réponse du joueur pour la 1e question	❌
question2	string	Body	✅	La réponse du joueur pour la 2e question	❌
question3	string	Body	✅	La réponse du joueur pour la 3e question	❌
question4	string	Body	✅	La réponse du joueur pour la 4e question	❌
question5	string	Body	✅	La réponse du joueur pour la 5e question	❌
stage1	bool	Body	❌	Si le joueur a passer la 1e palier	null
stage2	bool	Body	❌	Si le joueur a passer la 2e palier	null
stage3	bool	Body	❌	Si le joueur a passer la 3e palier	null
comment	bool	Body	✅	Pour rajouter un commentaire	❌

🧾 Réponse

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

Nom	Type	Nullable	Description
id	number	❌	L'id de la réponse
playerId	number	❌	L'id du player qui a répondue
video	string	❌	un lien vers une vidéo
question1	string	❌	La réponse du joueur pour la 1e question
question2	string	❌	La réponse du joueur pour la 2e question
question3	string	❌	La réponse du joueur pour la 3e question
question4	string	❌	La réponse du joueur pour la 4e question
question5	string	❌	La réponse du joueur pour la 5e question
stage1	bool	❌	Si le joueur a passer la 1e palier
stage2	bool	❌	Si le joueur a passer la 2e palier
stage3	bool	❌	Si le joueur a passer la 3e palier
comment	bool	❌	Pour rajouter un commentaire

📤 Exemple de requête

http://0.0.0.0/api/form/create-form

Et dans le body mettre par exemple :

{
    "playerId": 1,
    "video": "https://www.youtube.com/watch?v=GBIIQ0kP15E",
    "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",
    "comment": "Never gonna tell a lie and hurt you"
}

📥 Exemple de réponse

Si le formulaire est bien créé (code 201) :

{
    "id" : 0,
    "playerId": 1,
    "video": "https://www.youtube.com/watch?v=GBIIQ0kP15E",
    "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 HTTP	Description	Cause possible
400	Bad Request	Paramètres manquants ou invalides
401	Unauthorized	Clé API manquante ou invalide
403	Forbidden	Droits insuffisants pour utiliser la requête
500	Internal Server Error	Erreur 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

Nom	Type	Description
code	number	Le code d'erreur que retourne la requête
message	string	Le message de l'API expliquant l'erreur

Exemple avec l'erreur 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas accès à cette requête.

{
    "message": "Access Denied",
    "code": 403
}