Aller au contenu principal

PATCH /form/update-status

version 2.0.0

Modifier le status.

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 :

NomTypeDansRequisDescription
idnumberbodyL'id de la question
statusboolbodySi le formulaire est actif

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id de la question
statusboolSi le formulaire est actif

📤 Exemple de requête

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

Et dans le body mettre par exemple :

{
"id": 2,
"status": true
}

📥 Exemple de réponse

Si le status a bien été modifiée (code 201) :

{
"id": 2,
"status": true
}

⛔ 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
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 403 Forbidden :

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

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