Dismoi?

Formulaires

Liste les formulaires GET

`/v1/sites/{code_site}/forms.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

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"
    }
]

Nom	Type	Description
`form_id`	integer	Identifiant unique du formulaire
`name`	string	Intitulé du formulaire
`is_enabled`	boolean	Définit si le formulaire est visible
`use_captcha`	boolean	Définit si le formulaire est protégé par captcha
`recipient`	string	Déstinataire de l'email de notification
`subject`	string	Sujet de l'email de notification
`copy_to_sender`	boolean	Envoyer une copie à l'expéditeur
`message`	string	Message de remerciement
`replies_count`	integer	Nombre de réponses
`replies_unread_count`	integer	Nombre de réponses non lues
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification
`form_key`	string	Clé API du formulaire
`is_consent_required`	boolean	Activation du recueil du consentement
`processing_purposes`Facultatif	string	Finalité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 :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`name`	Obligatoire	string	Intitulé du formulaire
`is_enabled`	Obligatoire	boolean	Définit si le formulaire est accessible
`use_captcha`	Obligatoire	boolean	Définit si le formulaire est protégé par captcha
`recipient`		string	Déstinataire de l'email de notification
`subject`		string	Sujet de l'email de notification
`copy_to_sender`	Obligatoire	boolean	Envoyer une copie à l'expéditeur
`message`	Obligatoire	string	Message de remerciement
`is_consent_required`		boolean	Activation du recueil du consentement
`processing_purposes`		string	Finalités de traitement des données du formulaire

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Retourne les paramètres d'un formulaire GET

`/v1/sites/{code_site}/forms/{form_id}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

form_id Obligatoire integer Identifiant du formulaire

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

fields

Liste des champs du formulaire

Format de sortie :

Schéma JSON
Modèle

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"
}

Nom	Type	Description
`form_id`	integer	Identifiant unique du formulaire
`name`	string	Intitulé du formulaire
`is_enabled`	boolean	Définit si le formulaire est visible
`use_captcha`	boolean	Définit si le formulaire est protégé par captcha
`recipient`	string	Déstinataire de l'email de notification
`subject`	string	Sujet de l'email de notification
`copy_to_sender`	boolean	Envoyer une copie à l'expéditeur
`message`	string	Message de remerciement
`replies_count`	integer	Nombre de réponses
`replies_unread_count`	integer	Nombre de réponses non lues
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification
`form_key`	string	Clé API du formulaire
`is_consent_required`	boolean	Activation du recueil du consentement
`processing_purposes`Facultatif	string	Finalité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 :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant du formulaire
`name`		string	Intitulé du formulaire
`is_enabled`		boolean	Définit si le formulaire est accessible
`use_captcha`		boolean	Définit si le formulaire est protégé par captcha
`recipient`		string	Déstinataire de l'email de notification
`subject`		string	Sujet de l'email de notification
`copy_to_sender`		boolean	Envoyer une copie à l'expéditeur
`message`		string	Message de remerciement
`is_consent_required`		boolean	Activation du recueil du consentement
`processing_purposes`		string	Finalité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 :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant du formulaire
`name`		string	Intitulé du formulaire
`is_enabled`		boolean	Définit si le formulaire est accessible
`use_captcha`		boolean	Définit si le formulaire est protégé par captcha
`recipient`		string	Déstinataire de l'email de notification
`subject`		string	Sujet de l'email de notification
`copy_to_sender`		boolean	Envoyer une copie à l'expéditeur
`message`		string	Message de remerciement

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Supprime un formulaire DELETE

`/v1/sites/{code_site}/forms/{form_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant 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 :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant du formulaire

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "field_id": "integer",
        "name": "string",
        "alias": "string",
        "type": "string",
        "use_for_exp": "boolean",
        "is_unique": "boolean",
        "is_enabled": "boolean",
        "is_required": "boolean",
        "is_in_subject": "boolean",
        "values": [
            []
        ],
        "help": "string",
        "position": "integer",
        "creation_date": "string",
        "modification_date": "string"
    }
]

Nom	Type	Description
`field_id`	integer	Identifiant unique du champ
`name`	string	Nom du champ
`alias`	string	Alias
`type`	string	Type du champ
`use_for_exp`	boolean	Utiliser la valeur du champ comme l'adresse de l'expediteur
`is_unique`	boolean	Autorise une réponse par adresse email. Pour les champs de type email uniquement.
`is_enabled`	boolean	Champ visible
`is_required`	boolean	Champ obligatoire
`is_in_subject`	boolean	La valeur du champ est utilisé dans la sujet de l'email
`values`Facultatif	object	Valeurs possible du champ
`help`	string	Aide à la saise
`position`	integer	Position
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date 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 :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant du formulaire
`order`	Obligatoire	array	Liste 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 :

Nom Type Description

code_site Obligatoire string Code site

form_id Obligatoire integer Identifiant du formulaire

name Obligatoire string Intitulé du champ

alias string Alias

help string Aide à la saisie. Courte description pour aider à correctement renseigner le champ.

is_enabled boolean Afficher le champ (défaut : non)

is_required boolean Determine si le champ est requis ou non (défaut : non)

is_in_subject boolean Determine si le champ est utilisé dans le sujet de l'email

type

Obligatoire

string

Type de champ parmis les valeurs suivantes :

text	Texte
textarea	Texte multiligne
date	Date
datetime	Date et heure
numbers	Que des chiffres
letters	Que des lettres
email	Adresse e-mail
gender	Civilité
select	Liste déroulante
checkbox	Cases à cocher
radio	Boutons radio
fieldset	Groupe de champs (fieldset)
upload	Fichier à envoyer
department	Départements
region	Régions
country	Pays
hidden	Caché

Les valeurs attendues sont : text, textarea, date, datetime, numbers, letters, email, gender, select, checkbox, radio, fieldset, upload, department, region, country, hidden

use_for_exp boolean Pour les champs de type email, determine si valeur doit être utilisée comme expediteur du message

is_unique boolean Pour les champs de type email, autorise une réponse par adresse email

values array Valeurs possible pour le champ

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Supprime tous les champs d'un formulaire DELETE

`/v1/sites/{code_site}/forms/{form_id}/fields.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant 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 :

Nom Type Description

code_site Obligatoire string Code site

form_id Obligatoire integer Identifiant du formulaire

field_id Obligatoire integer Identifiant du champ

name string Intitulé du champ

alias string Alias

help string Aide à la saisie. Courte description pour aider à correctement renseigner le champ.

is_enabled boolean Afficher le champ

is_required boolean Determine si le champ est requis ou non

type

string

Type de champ parmis les valeurs suivantes :

text	Texte
textarea	Texte multiligne
date	Date
datetime	Date et heure
numbers	Que des chiffres
letters	Que des lettres
email	Adresse e-mail
gender	Civilité
select	Liste déroulante
checkbox	Cases à cocher
radio	Boutons radio
fieldset	Groupe de champs (fieldset)
upload	Fichier à envoyer
department	Départements
region	Régions
country	Pays
hidden	Caché

Les valeurs attendues sont : text, textarea, date, datetime, numbers, letters, email, gender, select, checkbox, radio, fieldset, upload, department, region, country, hidden

is_in_subject boolean Determine si le champ est utilisé dans le sujet de l'email

use_for_exp boolean Pour les champs de type email, determine si valeur doit être utilisée comme expediteur du message

is_unique boolean Pour les champs de type email, autorise une réponse par adresse email

values array Valeurs possible pour le champ

Format de sortie :

Schéma JSON
Modèle

data:{
    "field_id": "integer",
    "name": "string",
    "alias": "string",
    "type": "string",
    "use_for_exp": "boolean",
    "is_unique": "boolean",
    "is_enabled": "boolean",
    "is_required": "boolean",
    "is_in_subject": "boolean",
    "values": [
        []
    ],
    "help": "string",
    "position": "integer",
    "creation_date": "string",
    "modification_date": "string"
}

Nom	Type	Description
`field_id`	integer	Identifiant unique du champ
`name`	string	Nom du champ
`alias`	string	Alias
`type`	string	Type du champ
`use_for_exp`	boolean	Utiliser la valeur du champ comme l'adresse de l'expediteur
`is_unique`	boolean	Autorise une réponse par adresse email. Pour les champs de type email uniquement.
`is_enabled`	boolean	Champ visible
`is_required`	boolean	Champ obligatoire
`is_in_subject`	boolean	La valeur du champ est utilisé dans la sujet de l'email
`values`Facultatif	object	Valeurs possible du champ
`help`	string	Aide à la saise
`position`	integer	Position
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification

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 :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant du formulaire
`field_id`	Obligatoire	integer	Identifiant 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 :

Nom Type Description

code_site Obligatoire string Code site

form_id integer Identifiant du formulaire

is_read boolean Filtre les résultats sur les réponses lues/non lues

creation_date_min string Jour de création minimale (YYYY-MM-DD)

creation_date_max string Jour de création maximale (YYYY-MM-DD)

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 100)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

forms

Données relatives aux formulaire

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "response_id": "integer",
        "form_id": "integer",
        "is_read": "boolean",
        "ip": "string",
        "email_status": "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"
    }
]

Nom	Type	Description
`response_id`	integer	Identifiant unique de la réponse
`form_id`	integer	Identifiant unique du formulaire
`is_read`	boolean	Statut de lecture du formulaire
`ip`	string	Adresse IP de l'auteur du commentaire
`email_status`Facultatif	string	Statut de l'envoi de l'email de confirmation. Les valeurs possibles sont : SENT, FORCE_SENT, DISABLED, DISABLED_CAPTCHA, CANCELED_TPL, CANCELED_SPAM
`fields`	object
`field_id`	integer	Identifiant unique du champ
`type`	string	Type du champ
`name`	string	Nom du champ
`value`	string	Réponse renseignée par l'auteur
`reverse_host`	string	Reverse host de l'auteur du commentaire
`creation_date`	string	Date de création
`subject`Facultatif	string	Sujet
`form_name`Facultatif	string	Intitulé du formulaire
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Date de création au format timestamp

Supprime un lot de réponses DELETE

`/v1/sites/{code_site}/forms/responses.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`responses`		array	Identifiants de réponses (max:100). Laisser vide pour tout supprimer.

Détail d'une réponse GET

`/v1/sites/{code_site}/forms/responses/{response_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`response_id`	Obligatoire	integer	Identifiant de la réponse

Format de sortie :

Schéma JSON
Modèle

data:{
    "response_id": "integer",
    "form_id": "integer",
    "is_read": "boolean",
    "ip": "string",
    "email_status": "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"
}

Nom	Type	Description
`response_id`	integer	Identifiant unique de la réponse
`form_id`	integer	Identifiant unique du formulaire
`is_read`	boolean	Statut de lecture du formulaire
`ip`	string	Adresse IP de l'auteur du commentaire
`email_status`Facultatif	string	Statut de l'envoi de l'email de confirmation. Les valeurs possibles sont : SENT, FORCE_SENT, DISABLED, DISABLED_CAPTCHA, CANCELED_TPL, CANCELED_SPAM
`fields`	object
`field_id`	integer	Identifiant unique du champ
`type`	string	Type du champ
`name`	string	Nom du champ
`value`	string	Réponse renseignée par l'auteur
`reverse_host`	string	Reverse host de l'auteur du commentaire
`creation_date`	string	Date de création
`subject`Facultatif	string	Sujet
`form_name`Facultatif	string	Intitulé du formulaire
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Date de création au format timestamp

Modifie une réponse PUT

`/v1/sites/{code_site}/forms/responses/{response_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`response_id`	Obligatoire	integer	Identifiant de la réponse
`is_read`		boolean	Statut lu
`fields`		array	Résponses à modifier et leurs valeurs
`force_email`		boolean	Force le renvoi du mail confirmation

Format de sortie :

Schéma JSON
Modèle

data:{
    "response_id": "integer",
    "form_id": "integer",
    "is_read": "boolean",
    "ip": "string",
    "email_status": "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"
}

Nom	Type	Description
`response_id`	integer	Identifiant unique de la réponse
`form_id`	integer	Identifiant unique du formulaire
`is_read`	boolean	Statut de lecture du formulaire
`ip`	string	Adresse IP de l'auteur du commentaire
`email_status`Facultatif	string	Statut de l'envoi de l'email de confirmation. Les valeurs possibles sont : SENT, FORCE_SENT, DISABLED, DISABLED_CAPTCHA, CANCELED_TPL, CANCELED_SPAM
`fields`	object
`field_id`	integer	Identifiant unique du champ
`type`	string	Type du champ
`name`	string	Nom du champ
`value`	string	Réponse renseignée par l'auteur
`reverse_host`	string	Reverse host de l'auteur du commentaire
`creation_date`	string	Date de création
`subject`Facultatif	string	Sujet
`form_name`Facultatif	string	Intitulé du formulaire
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Date de création au format timestamp

Supprime une réponse DELETE

`/v1/sites/{code_site}/forms/responses/{response_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`response_id`	Obligatoire	integer	Identifiant de la réponse

Ajoute une réponse POST

`/v1/sites/{code_site}/forms/{form_id}/responses.json`

Publie une réponse dans un formulaire dismoi.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant du formulaire
`fields`	Obligatoire	array	Réponses du formulaire Dismoi?
`send_email`		boolean	Envoi des emails de récapitulatif de la réponse (les envois sont activés par défaut)
`model`		string	Modele utilisé pour le formulaire, determine quel template d'email sera utilisé pour l'email de notification

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Liste les réponses GET

`/v1/sites/{code_site}/forms/{form_id}/responses.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant du formulaire
`unread_only`		boolean	Limite les resultats aux réponses non lues
`creation_date_min`		string	Jour de création minimale (YYYY-MM-DD)
`creation_date_max`		string	Jour de création maximale (YYYY-MM-DD)
`limit`		integer	Nombre d'éléments par page (valeur par défaut : 20, maximum : 100)
`page`		integer	Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "response_id": "integer",
        "form_id": "integer",
        "is_read": "boolean",
        "ip": "string",
        "email_status": "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"
    }
]

Nom	Type	Description
`response_id`	integer	Identifiant unique de la réponse
`form_id`	integer	Identifiant unique du formulaire
`is_read`	boolean	Statut de lecture du formulaire
`ip`	string	Adresse IP de l'auteur du commentaire
`email_status`Facultatif	string	Statut de l'envoi de l'email de confirmation. Les valeurs possibles sont : SENT, FORCE_SENT, DISABLED, DISABLED_CAPTCHA, CANCELED_TPL, CANCELED_SPAM
`fields`	object
`field_id`	integer	Identifiant unique du champ
`type`	string	Type du champ
`name`	string	Nom du champ
`value`	string	Réponse renseignée par l'auteur
`reverse_host`	string	Reverse host de l'auteur du commentaire
`creation_date`	string	Date de création
`subject`Facultatif	string	Sujet
`form_name`Facultatif	string	Intitulé du formulaire
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Date 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 :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`form_id`	Obligatoire	integer	Identifiant du formulaire