Dismoi?

Formulaires

Liste les formulaires GET
/v1/sites/{code_site}/forms.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "form_id": "integer",
        "name": "string",
        "is_enabled": "boolean",
        "use_captcha": "boolean",
        "recipient": "string",
        "subject": "string",
        "copy_to_sender": "boolean",
        "message": "string",
        "replies_count": "integer",
        "replies_unread_count": "integer",
        "creation_date": "string",
        "modification_date": "string",
        "form_key": "string",
        "is_consent_required": "boolean",
        "processing_purposes": "string"
    }
]
NomTypeDescription
form_idintegerIdentifiant unique du formulaire
namestringIntitulé du formulaire
is_enabledbooleanDéfinit si le formulaire est visible
use_captchabooleanDéfinit si le formulaire est protégé par captcha
recipientstringDéstinataire de l'email de notification
subjectstringSujet de l'email de notification
copy_to_senderbooleanEnvoyer une copie à l'expéditeur
messagestringMessage de remerciement
replies_countintegerNombre de réponses
replies_unread_countintegerNombre de réponses non lues
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
form_keystringClé API du formulaire
is_consent_requiredbooleanActivation du recueil du consentement
processing_purposesFacultatifstringFinalités de traitement des données du formulaire
Ajoute un formulaire POST
/v1/sites/{code_site}/forms.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
nameObligatoirestringIntitulé du formulaire
is_enabledObligatoirebooleanDéfinit si le formulaire est accessible
use_captchaObligatoirebooleanDéfinit si le formulaire est protégé par captcha
recipientstringDéstinataire de l'email de notification
subjectstringSujet de l'email de notification
copy_to_senderObligatoirebooleanEnvoyer une copie à l'expéditeur
messageObligatoirestringMessage de remerciement
is_consent_requiredbooleanActivation du recueil du consentement
processing_purposesstringFinalités de traitement des données du formulaire

Format de sortie :

data:[]
NomTypeDescription
Retourne les paramètres d'un formulaire GET
/v1/sites/{code_site}/forms/{form_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
fieldsListe des champs du formulaire

Format de sortie :

data:{
    "form_id": "integer",
    "name": "string",
    "is_enabled": "boolean",
    "use_captcha": "boolean",
    "recipient": "string",
    "subject": "string",
    "copy_to_sender": "boolean",
    "message": "string",
    "replies_count": "integer",
    "replies_unread_count": "integer",
    "creation_date": "string",
    "modification_date": "string",
    "form_key": "string",
    "is_consent_required": "boolean",
    "processing_purposes": "string"
}
NomTypeDescription
form_idintegerIdentifiant unique du formulaire
namestringIntitulé du formulaire
is_enabledbooleanDéfinit si le formulaire est visible
use_captchabooleanDéfinit si le formulaire est protégé par captcha
recipientstringDéstinataire de l'email de notification
subjectstringSujet de l'email de notification
copy_to_senderbooleanEnvoyer une copie à l'expéditeur
messagestringMessage de remerciement
replies_countintegerNombre de réponses
replies_unread_countintegerNombre de réponses non lues
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
form_keystringClé API du formulaire
is_consent_requiredbooleanActivation du recueil du consentement
processing_purposesFacultatifstringFinalités de traitement des données du formulaire
Modifie les paramètres d'un formulaire PUT
/v1/sites/{code_site}/forms/{form_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
namestringIntitulé du formulaire
is_enabledbooleanDéfinit si le formulaire est accessible
use_captchabooleanDéfinit si le formulaire est protégé par captcha
recipientstringDéstinataire de l'email de notification
subjectstringSujet de l'email de notification
copy_to_senderbooleanEnvoyer une copie à l'expéditeur
messagestringMessage de remerciement
is_consent_requiredbooleanActivation du recueil du consentement
processing_purposesstringFinalités de traitement des données du formulaire
Copie un formulaire POST
/v1/sites/{code_site}/forms/{form_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
namestringIntitulé du formulaire
is_enabledbooleanDéfinit si le formulaire est accessible
use_captchabooleanDéfinit si le formulaire est protégé par captcha
recipientstringDéstinataire de l'email de notification
subjectstringSujet de l'email de notification
copy_to_senderbooleanEnvoyer une copie à l'expéditeur
messagestringMessage de remerciement

Format de sortie :

data:[]
NomTypeDescription
Supprime un formulaire DELETE
/v1/sites/{code_site}/forms/{form_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire

Champs

Liste les champs d'un formulaire GET
/v1/sites/{code_site}/forms/{form_id}/fields.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire

Format de sortie :

data:[
    {
        "field_id": "integer",
        "name": "string",
        "type": "string",
        "use_for_exp": "boolean",
        "is_enabled": "boolean",
        "is_required": "boolean",
        "is_in_subject": "boolean",
        "values": [
            []
        ],
        "help": "string",
        "position": "integer",
        "creation_date": "string",
        "modification_date": "string"
    }
]
NomTypeDescription
field_idintegerIdentifiant unique du champ
namestringNom du champ
typestringType du champ
use_for_expbooleanUtiliser la valeur du champ comme l'adresse de l'expediteur
is_enabledbooleanChamp visible
is_requiredbooleanChamp obligatoire
is_in_subjectbooleanLa valeur du champ est utilisé dans la sujet de l'email
valuesFacultatifobjectValeurs possible du champ
helpstringAide à la saise
positionintegerPosition
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
Réordonne les champs d'un formulaire PUT
/v1/sites/{code_site}/forms/{form_id}/fields.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
orderObligatoirearrayListe des identifiants des champs
Ajoute un champ dans un formulaires POST
/v1/sites/{code_site}/forms/{form_id}/fields.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
nameObligatoirestringIntitulé du champ
helpstringAide à la saisie. Courte description pour aider à correctement renseigner le champ.
is_enabledbooleanAfficher le champ (défaut : non)
is_requiredbooleanDetermine si le champ est requis ou non (défaut : non)
is_in_subjectbooleanDetermine si le champ est utilisé dans le sujet de l'email
typeObligatoirestringType de champ parmis les valeurs suivantes :
textTexte
textareaTexte multiligne
dateDate
datetimeDate et heure
numbersQue des chiffres
lettersQue des lettres
emailAdresse e-mail
genderCivilité
selectListe déroulante
checkboxCases à cocher
radioBoutons radio
fieldsetGroupe de champs (fieldset)
uploadFichier à envoyer
departmentDépartements
regionRégions
countryPays

Les valeurs attendues sont : text, textarea, date, datetime, numbers, letters, email, gender, select, checkbox, radio, fieldset, upload, department, region, country
use_for_expbooleanPour les champs de type email, determine si valeur doit être utilisée comme expediteur du message
valuesarrayValeurs possible pour le champ

Format de sortie :

data:[]
NomTypeDescription
Supprime tous les champs d'un formulaire DELETE
/v1/sites/{code_site}/forms/{form_id}/fields.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
Modifie un champ d'un formulaire PUT
/v1/sites/{code_site}/forms/{form_id}/fields/{field_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
field_idObligatoireintegerIdentifiant du champ
namestringIntitulé du champ
helpstringAide à la saisie. Courte description pour aider à correctement renseigner le champ.
is_enabledbooleanAfficher le champ
is_requiredbooleanDetermine si le champ est requis ou non
typestringType de champ parmis les valeurs suivantes :
textTexte
textareaTexte multiligne
dateDate
datetimeDate et heure
numbersQue des chiffres
lettersQue des lettres
emailAdresse e-mail
genderCivilité
selectListe déroulante
checkboxCases à cocher
radioBoutons radio
fieldsetGroupe de champs (fieldset)
uploadFichier à envoyer
departmentDépartements
regionRégions
countryPays

Les valeurs attendues sont : text, textarea, date, datetime, numbers, letters, email, gender, select, checkbox, radio, fieldset, upload, department, region, country
is_in_subjectbooleanDetermine si le champ est utilisé dans le sujet de l'email
use_for_expbooleanPour les champs de type email, determine si valeur doit être utilisée comme expediteur du message
valuesarrayValeurs possible pour le champ
Supprime un champ d'un formulaire DELETE
/v1/sites/{code_site}/forms/{form_id}/fields/{field_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
field_idObligatoireintegerIdentifiant du champ

Réponses

Liste toutes les réponses aux formulaires GET
/v1/sites/{code_site}/forms/responses.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idintegerIdentifiant du formulaire
is_readbooleanFiltre les résultats sur les réponses lues/non lues
creation_date_minstringJour de création minimale (YYYY-MM-DD)
creation_date_maxstringJour de création maximale (YYYY-MM-DD)
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
formsDonnées relatives aux formulaire

Format de sortie :

data:[
    {
        "response_id": "integer",
        "form_id": "integer",
        "is_read": "boolean",
        "ip": "string",
        "fields": [
            {
                "field_id": "integer",
                "type": "string",
                "name": "string",
                "value": "string"
            }
        ],
        "reverse_host": "string",
        "creation_date": "string",
        "subject": "string",
        "form_name": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer"
    }
]
NomTypeDescription
response_idintegerIdentifiant unique de la réponse
form_idintegerIdentifiant unique du formulaire
is_readbooleanStatut de lecture du formulaire
ipstringAdresse IP de l'auteur du commentaire
fieldsobject
field_idintegerIdentifiant unique du champ
typestringType du champ
namestringNom du champ
valuestringRéponse renseignée par l'auteur
reverse_hoststringReverse host de l'auteur du commentaire
creation_datestringDate de création
subjectFacultatifstringSujet
form_nameFacultatifstringIntitulé du formulaire
creation_date_fstringDate de création formatée
creation_date_timestampintegerDate de création au format timestamp
Récupère une réponse d'un formulaire GET
/v1/sites/{code_site}/forms/responses/{response_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
response_idObligatoireintegerIdentifiant de la réponse

Format de sortie :

data:{
    "response_id": "integer",
    "form_id": "integer",
    "is_read": "boolean",
    "ip": "string",
    "fields": [
        {
            "field_id": "integer",
            "type": "string",
            "name": "string",
            "value": "string"
        }
    ],
    "reverse_host": "string",
    "creation_date": "string",
    "subject": "string",
    "form_name": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer"
}
NomTypeDescription
response_idintegerIdentifiant unique de la réponse
form_idintegerIdentifiant unique du formulaire
is_readbooleanStatut de lecture du formulaire
ipstringAdresse IP de l'auteur du commentaire
fieldsobject
field_idintegerIdentifiant unique du champ
typestringType du champ
namestringNom du champ
valuestringRéponse renseignée par l'auteur
reverse_hoststringReverse host de l'auteur du commentaire
creation_datestringDate de création
subjectFacultatifstringSujet
form_nameFacultatifstringIntitulé du formulaire
creation_date_fstringDate de création formatée
creation_date_timestampintegerDate de création au format timestamp
Modifie une réponse d'un formulaire PUT
/v1/sites/{code_site}/forms/responses/{response_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
response_idObligatoireintegerIdentifiant de la réponse
is_readbooleanStatut lu
fieldsarrayRésponses à modifier et leurs valeurs
Supprime une réponse d'un formulaire DELETE
/v1/sites/{code_site}/forms/responses/{response_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
response_idObligatoireintegerIdentifiant de la réponse
Ajoute une réponse à un formulaire POST
/v1/sites/{code_site}/forms/{form_id}/responses.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
fieldsObligatoirearrayRéponses du formulaire Dismoi?
send_emailbooleanEnvoi des emails de récapitulatif de la réponse (les envois sont activés par défaut)
modelstringModele utilisé pour le formulaire, determine quel template d'email sera utilisé pour l'email de notification

Format de sortie :

data:[]
NomTypeDescription
Liste les réponses d'un formulaire GET
/v1/sites/{code_site}/forms/{form_id}/responses.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire
unread_onlybooleanLimite les resultats aux réponses non lues
creation_date_minstringJour de création minimale (YYYY-MM-DD)
creation_date_maxstringJour de création maximale (YYYY-MM-DD)
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

data:[
    {
        "response_id": "integer",
        "form_id": "integer",
        "is_read": "boolean",
        "ip": "string",
        "fields": [
            {
                "field_id": "integer",
                "type": "string",
                "name": "string",
                "value": "string"
            }
        ],
        "reverse_host": "string",
        "creation_date": "string",
        "subject": "string",
        "form_name": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer"
    }
]
NomTypeDescription
response_idintegerIdentifiant unique de la réponse
form_idintegerIdentifiant unique du formulaire
is_readbooleanStatut de lecture du formulaire
ipstringAdresse IP de l'auteur du commentaire
fieldsobject
field_idintegerIdentifiant unique du champ
typestringType du champ
namestringNom du champ
valuestringRéponse renseignée par l'auteur
reverse_hoststringReverse host de l'auteur du commentaire
creation_datestringDate de création
subjectFacultatifstringSujet
form_nameFacultatifstringIntitulé du formulaire
creation_date_fstringDate de création formatée
creation_date_timestampintegerDate de création au format timestamp
Supprime toutes les réponses d'un formulaire DELETE
/v1/sites/{code_site}/forms/{form_id}/responses.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idObligatoireintegerIdentifiant du formulaire