Ajouter des boutons radio

Un champ est l’objet qui porte l’action à effectuer par un participant. Un champ a un type qui peut être soit :

  • signature (pour une demande de signature par une personne physique ou un cachet par une personne morale),
  • visa (pour une demande de consultation par une personne physique),
  • text (pour un champ de texte à remplir par le participant),
  • label (pour un texte en lecture seule ajouté par le créateur de la transaction sur un document),
  • checkbox_group (pour un groupe de cases à cocher par le participant),
  • checkbox (pour une case à cocher par le participant),
  • radio_group (pour un groupe de boutons radio à cocher par le participant),
  • radiobutton (pour un bouton radio à cocher par le participant),
  • dropdown (pour une liste déroulante dans laquelle le participant doit sélectionner une option).
  • image (pour un champ image dans lequel le participant doit importer un fichier image),
  • signature_date (pour un champ qui affiche la date et l’heure auxquelles le participant a signé le document),
  • full_name (pour un champ qui affiche le nom complet du participant),
  • email (pour un champ qui affiche l’email du participant),
  • company_name (pour un champ qui affiche le nom de l’entreprise du participant),
  • job_title (pour un champ qui affiche la fonction du participant).

Vous pouvez également ajouter des Paraphes.

A propos des champs « Bouton radio »

Un champ « Bouton radio » est un élément qui doit être coché par le participant lors du parcours de signature.

Lorsque vous ajoutez pour la première fois un champ « Bouton radio » à un document, un groupe de boutons radio avec un identifiant unique est automatiquement créé.

Notez que vous ne pouvez pas ajouter de champs :

  • sur un document qui a déjà été traité par un participant,
  • sur un document qui contient déjà une signature (avant d’être importé dans la transaction).

Créer un groupe de boutons radio

Pour ajouter des boutons radio à une transaction, vous devez d’abord créer un groupe de boutons radio (sauf si vous envoyez une Full transaction request).

Pour créer un groupe de boutons radio, envoyez une demande à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields et transmettez radio_group dans l’argument type et le nom unique du groupe de boutons radio dans l’argument name.

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields \
-d type=radio_group \
-d name=RadioGroup1 \

L’API renvoie un sous-objet field.

{
 "id": "fld_ekD",
 "name": "RadioGroup1",
 "type": "radio_group",
 "built_in": false,
 "updatable": true,
 "deletable": true,
 "required": true
}

Conditions

  • Le nom du groupe de boutons radio doit être unique dans le même document (y compris les groupes de boutons radio). Si le nom du groupe de boutons radio existe déjà, l’API renvoie une erreur.
  • Si le nom du groupe de boutons radio n’est pas spécifié, une valeur unique est automatiquement attribuée.
  • La position et la taille ne sont pas disponibles. Le groupe de boutons radio n’est pas visible dans le document.
  • Les participants sont attribués à l’ensemble du groupe de boutons radio et non à des boutons radio distinctS (cela nous permet de nous assurer que tous les boutons radio d’un groupe sont attribués au même participant).

Éditer un groupe de boutons radio

Vous pouvez éditer le nom d’un groupe de boutons radio. Pour ce faire, envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id} et transmettez le nouveau nom du groupe de boutons radio dans l’argument name.

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields/fld_w4Dw \
-d name=NewRadioGroup1 /

L’API renvoie un sous-objet field mis à jour.

{
 "id": "fld_ekD",
 "name": "NewRadioGroup1",
 "type": "radio_group",
 "built_in": false,
 "updatable": true,
 "deletable": true,
 "required": true
}

Notez que vous pouvez mettre à jour le nom d’un groupe de boutons radio, tant que :

  • le participant désigné n’a pas encore signé le document,
  • le validateur n’a pas encore approuvé le document du signataire.

Ajouter un bouton radio

Pour ajouter un champ bouton radio à un groupe de boutons radio, envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields et transmettez radiobutton dans l’argument type, l’id ou le nom du groupe de boutons radio dans l’argument parent, ainsi que les arguments de position (page, x et y).

Vous pouvez définir d’autres arguments optionnels :

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields \
-d type=radiobutton \
-d parent=RadioGroup1 \
-d name=RadionButton1 \
-d page=1 \
-d x=23 \
-d y=20 \
-d checked=false
  • parent : le groupe de boutons radio auquel le bouton radio est lié, identifié par son name ou son id.
  • name : le nom du champ.
  • page : le numéro de la page sur laquelle vous souhaitez positionner le champ.
  • x : coordonnée horizontale du champ sur la page du document (en pixels).
  • y : coordonnée verticale du champ sur la page du document (en pixels).
  • checked : si défini sur true, le bouton radio est déjà coché lorsqu’il est ajouté au document. La valeur par défaut est false.

L’API renvoie un sous-objet field.

{
"id" : "fld_A0Oz",
"name" : "RadioButton1",
"type" : "radiobutton",
"position" : {
"page" : 1,
"x" : 23,
"y" : 20,
"width" : 15,
"height" : 15
},
"built_in" : false,
"updatable" : true,
"deletable" : true,
"parent" : "fld_0MMM",
"checked" : false
}

Conditions

  • Le nom du bouton radio doit être unique au sein d’un même groupe. Si le nom du bouton radio existe déjà, l’API renvoie une erreur.
  • Si le nom du bouton radio n’est pas spécifié, une valeur unique est automatiquement attribuée.
  • Tous les boutons radio doivent être liés à un groupe de boutons radio (parent).
  • La taille du bouton radio est fixée à 15px x 15px et ne peut pas être modifiée.
  • Le bouton radio ne peut pas être attribué à un participant (sauf si vous envoyez une Full transaction request). Seuls les groupes de boutons radio sont attribués aux participants.

Éditer un bouton radio

Pour éditer un bouton radio, envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id}.

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields/fld_qOK0 \
-d name=NewRadioButton1 \
-d parent=RadioGroup1 \
-d page=1 \
-d x=50 \
-d y=50 \
-d checked=true

L’API renvoie un sous-objet field mis à jour.

{
"id" : "fld_A0Oz",
"name" : "NewRadioButton1",
"type" : "radiobutton",
"position" : {
"page" : 1,
"x" : 50,
"y" : 50,
"width" : 15,
"height" : 15
},
"built_in" : false,
"updatable" : true,
"deletable" : true,
"parent" : "fld_0MMM",
"checked" : true
}

Conditions

  • Le nom mis à jour du bouton radio doit être unique au sein du même groupe. Si le nom du bouton radio existe déjà, l’API renvoie une erreur et aucune modification n’est enregistrée.
  • Le nom du bouton radio ne peut pas être mis à jour avec une valeur nulle, sinon l’API renvoie une erreur.
  • Le nom du groupe boutons radio (parent) ne peut pas être mis à jour avec une valeur nulle, sinon l’API renvoie une erreur.
  • Tous les boutons radio doivent être liés à un groupe de cases à cocher (parent).
  • La taille du bouton radio est fixée à 15px x 15px et ne peut pas être modifiée.

Déplacer un bouton radio

Vous pouvez déplacer un bouton radio vers une autre page du même document ou vers un autre document. Envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields et transmettez le document cible dans l’URL et l’identifiant du champ que vous souhaitez déplacer dans l’argument move_from :

curl
https://api.universign.com/v1/transactions/tx_DwYGle91EQZA/documents/doc_aJ4k/fields \
-d move_from=fld_A0Oz
  • Lorsque vous déplacez un champ bouton radio vers une autre page du même document, le champ conserve ses paramètres d’origine et reste dans le même groupe.
  • Lorsque vous déplacez un champ bouton radio vers un autre document de la transaction :
    • si le document cible contient déjà un groupe de boutons radio portant le même nom que dans le document d’origine, le bouton radio y est ajouté et hérite des attributs du groupe (tels que le signataire attribué).
    • si le document cible ne contient aucun groupe de boutons radio portant le même nom que dans le document d’origine, un nouveau groupe de boutons radio est créé avec le même nom que dans le document d’origine et le champ de bouton radio y est ajouté.

Notez que vous ne pouvez pas déplacer un groupe de boutons radio.

Pour plus d’informations, consultez Déplacer un champ.

Supprimer un bouton radio / un groupe de boutons radio

Pour supprimer un groupe de boutons radio, vous devez :

  1. Supprimer le participant attribué au groupe de boutons radio.
  2. Supprimer tous les boutons radio liés au groupe de boutons radio.
  3. Supprimer le groupe de boutons radio.

Notez que vous ne pouvez pas supprimer un groupe de boutons radio si le participant attribué a déjà effectué son action (validation ou signature).

Pour supprimer un bouton radio ou un groupe de boutons radio, envoyez une requête à DELETE /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id}.

curl
https://api.universign.com/v1/transactions/tx_qE67Zr640eVX/documents/doc_bd2a/fields/fld_A0Oz \
-X DELETE

Notez que les champs de bouton radio intégrés ne peuvent pas être supprimés.

Ajouter des cases à cocher
← Précédent
Ajouter une liste déroulante
Suivant →
Espace Développeur
Guides
Services
Référence API