Comment ajouter un formulaire à un contact

Introduction

Processus

1. Récupérer le formId :

• Lien vers la documentation API : Get Form Collection

• Utilisez Postman pour effectuer une requête GET pour la collection de formulaires et obtenez le formId à partir de la collection de formulaires reçue. Chaque formulaire reçu possède une propriété id qui doit être utilisée comme formId lors de la création d'un formulaire de candidat.

2. Formuler la relation :

• Combinez le candidateId, le formId, et les actions requises pour créer la relation candidateForm.

3. Créer la relation via l'API :

• Lien vers la documentation API : Create Candidate Form

• Point de terminaison : /candidate-forms

• Méthode : POST

• Corps de la requête :

{
  "candidateId": "your_candidate_id",
  "formId": "your_form_id",
  "actions": [
    "complete",
    "download"
  ],
  "fileId": "your_file_id",
  "signatureId": "your_signature_id",
  "isMandatory": false,
  "isPreliminary": false
}

Détails importants

Champs obligatoires :

• candidateId : L'identifiant unique du candidat.

• formId : L'identifiant unique du formulaire.

• actions : Un tableau d'actions à effectuer sur le formulaire

Champs optionnels :

• fileId : Si le type de formulaire est un fichier, vous pouvez remplacer la pièce jointe originale par une personnelle

• signatureId : Obligatoire si le formulaire nécessite un processus de signature. Le signatureId doit être obtenu à partir de la documentation du flux de signature : Get Signature by ID. Si le flux de signature nécessite une signature du candidat, vous devez ajouter l'action eSign dans actions.

• isMandatory : Valeur booléenne indiquant si le formulaire est obligatoire pour le candidat (par défaut false).

• isPreliminary : Valeur booléenne indiquant si le formulaire doit être affiché en premier lorsque le candidat ouvre la Filebox v2 (un seul formulaire peut avoir isPreliminary défini sur true).

Actions selon le type de formulaire :

• Actions du formulaire : Au moins une action est requise. Les actions autorisées dépendent du type du formulaire original.
• Lien vers les types de formulaires : Form Types
• Lien vers les actions : Form Actions

Types de formulaires et actions autorisées :

• Types File, Readonly et Combo :
• read
• eSign (uniquement si le candidat fait partie du flux de signature)
• download

• Type Editable :
• complete
• eSign (uniquement si le candidat fait partie du flux de signature)
• download

Étapes détaillées

Récupérer le formId :

1. Ouvrez Postman ou tout autre client API.

2. Effectuez une requête GET vers le point de terminaison approprié : Get Form Collection

3. Identifiez et notez l'id du formulaire souhaité dans la collection de formulaires reçue, et utilisez cet id comme formId.

Créer la relation :

1. Assurez-vous d'avoir le candidateId pour le candidat auquel vous souhaitez attribuer le formulaire.

2. Combinez le candidateId, le formId, les actions et toutes propriétés supplémentaires pour la relation candidateForm.

Requête API pour associer le formulaire :

1. Dans Postman ou tout autre client API, créez une nouvelle requête POST : Create Candidate Form

2. Définissez le point de terminaison sur /candidate-forms.

3. Dans le corps de la requête, incluez le candidateId, le formId, les actions et les autres propriétés comme indiqué dans l'exemple ci-dessus.

Ajouter plusieurs formulaires :

• Répétez la requête POST pour chaque formulaire supplémentaire que vous devez associer au candidat.

Exemple d'utilisation

Corps de la requête pour le premier formulaire :

{
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "actions": [
    "complete",
    "download"
  ],
  "isMandatory": true,
  "isPreliminary": true
}

Corps de la requête pour le deuxième formulaire :

{
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e092",
  "actions": [
    "read",
    "download"
  ],
  "fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e092",
  "signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e093"
}

Notes supplémentaires

• Assurez-vous que les paramètres candidateId et formId sont correctement formatés et valides.

• N'oubliez pas d'inclure actions car c'est un champ obligatoire.

• Les actions autorisées dépendent du type de formulaire. Référez-vous aux liens de documentation sur les types de formulaires et les actions fournis ci-dessus.

• Utilisez le champ fileId si le type de formulaire est un fichier.

• Utilisez le champ signatureId si le formulaire nécessite un processus de signature, et incluez l'action eSign pour que le candidat passe par le processus de signature.

• Définissez isMandatory sur true si le candidat doit obligatoirement remplir le formulaire.

• Un seul formulaire peut avoir isPreliminary défini sur true pour garantir qu'il soit affiché en premier lorsque le candidat ouvre la filebox.

• Vous pouvez ajouter autant de formulaires que nécessaire à l'entité candidat en répétant la requête POST avec différentes valeurs de formId.