Ajouter une liste déroulante

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 « Liste déroulante »

Vous pouvez ajouter une liste déroulante pour permettre à un participant de sélectionner une valeur parmi les différentes options lors du parcours de signature.

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 une liste déroulante

Pour créer une liste déroulante, envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields et transmettez dropdown dans l’argument type, le nom unique de la liste déroulante dans l’argument name et les arguments page, x et y.

Notez que si vous souhaitez supprimer une option de la liste déroulante, il vous suffit de supprimer l’argument options[key] associé lors de la mise à jour du champ.

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields \
-d type=dropdown \
-d name=DropdownList1 \
-d page=1 \
-d x=220 \
-d y=154 \
-d options[key1]=Option1 \
-d options[key2]=Option2 \
-d value=Option2 \

Vous pouvez définir d’autres arguments optionnels :

  • options[clé] : pour ajouter une option dans la liste déroulante, vous devez la spécifier sous forme de paire clé-valeur. La valeur de la clé options doit être ajoutée au champ options entre crochets (par exemple options[clé]) et ne doit pas dépasser 20 caractères. La paire clé-valeur de l’option doit être unique dans la même liste déroulante et la valeur ne doit pas dépasser 200 caractères. Vous pouvez ajouter jusqu’à 15 options par champ de liste déroulante. Notez que la valeur des options ne peut pas être laissée vide et ne doit pas contenir de barre oblique inversée \.
  • value : la valeur de l’option déroulante qui sera sélectionnée par défaut pour la liste déroulante. Si elle est définie, la valeur ne peut pas être laissée vide et ne doit pas dépasser 200 caractères. La valeur de l’option ne doit pas contenir de barre oblique inversée \.
  • height : la hauteur du champ (exprimée en unités d’espace utilisateur par défaut du PDF). La valeur par défaut est 19.
  • width : la largeur du champ (exprimée en unités d’espace utilisateur par défaut du PDF). La valeur par défaut est 200.
  • required : indique si le participant doit remplir le champ ou non. La valeur par défaut est true.

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

{
  "id" : "fld_MnLA",
  "name" : "DropdownList1",
  "type" : "dropdown",
  "position" : {
    "page" : 1,
    "x" : 220,
    "y" : 154,
    "width" : 200,
    "height" : 19
  },
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "max_length" : 27,
  "font_size" : 12,
  "options" : {
    "key1" : "Option1",
    "key2" : "Option2"
  },
  "value" : "Option2",
  "required" : true
}

Éditer une liste déroulante

Pour éditer une liste déroulante, envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id}.

curl
https://api.universign.com/v1/transactions/tx_DwYGle91EQZA/documents/doc_4dn/fields/fld_MnLA \
-d name=Updated DropdownList \
-d page=1 \
-d x=220 \
-d y=154 \
-d options[key2]=Option2 \
-d options[key3]=Option3 \
-d options[key4]=Option4 \
-d value=Option4 \

Dans l’exemple de requête ci-dessus, le champ « Liste déroulante » a été mis à jour comme suit :

  • options[key1] a été supprimé,
  • options[key3] et options[key4] ont été ajoutés,
  • value a été mis à jour.

Cela signifie que chaque fois que vous envoyez une requête pour mettre à jour un champ « Liste déroulante », vous devez passer les arguments options[*] des options que vous souhaitez conserver ou mettre à jour, sinon les options[*] manquantes que vous ne passez pas seront automatiquement supprimées (options[key1] dans ce cas).

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

{
  "id" : "fld_MnLA",
  "name" : "Updated DropdownList",
  "type" : "dropdown",
  "position" : {
    "page" : 1,
    "x" : 220,
    "y" : 154,
    "width" : 200,
    "height" : 19
  },
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "max_length" : 27,
  "font_size" : 12,
  "options" : {
    "key2" : "Option2",
    "key3" : "Option3",
    "key4" : "Option4"
  },
  "value" : "Option4",
  "required" : true
}

Déplacer une liste déroulante

Vous pouvez déplacer une liste déroulante 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_MnLA

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

Supprimer une liste déroulante

Pour supprimer une liste déroulante, vous devez :

  1. Supprimer le participant attribué à la liste déroulante.
  2. Supprimer la liste déroulante.

Notez que vous ne pouvez pas supprimer une liste déroulante si le participant attribué a déjà effectué son action (validation ou signature).

Pour supprimer une liste déroulante, 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_6WL \
-X DELETE

Notez que les champs de liste déroulante intégrés ne peuvent pas être supprimés.

Ajouter des boutons radio
← Précédent
Dupliquer un champ
Suivant →
Espace Développeur
Guides
Services
Référence API