NOTE: Le FriendlyName des membres du parcours ne doivent pas contenir d'espace. Tous les espaces seront supprimés le cas échéant.
1.
Création d'un parcours avec génération des Ids par Docage :
Les liaisons des objets se font via FriendlyName uniquement :
On crée un objet transaction avec transactionMembers et TransactionFiles sans Id
On modifie les infos des membres que l'on veut modifier ensuite via les Friendlyname :
Si on spécifie uniquement un Id => Le membre aura les coordonnées du contact ou du Docageuser correspondant
Si on spécifie un objet contact :
On met à jour le contact s'il contient un Id ou si le TransactionMember avec le même FriendlyName contient un ContactId
On crée un nouveau contact s'il ne contient pas d'Id et si le TransactionMember avec le même FriendlyName ne contient pas un ContactId
On modifie ensuite le contenu des transactionfiles via FriendlyName et FormFile
On ajoute les signatureLocations ensuite via les friendlyname et un objet transactionMemberSignatureLocation sans Id
2.
Creátion d'un parcours avec fourniture des Ids par le développeur :
Les liaisons des objets se font via les Ids fournis. Utile pour faire correspondre les Ids des objets Docage avec les Ids de vos objets.
On crée un objet transaction avec transactionMembers, TransactionFiles et SignatureLocations avec des Ids
On ajoute les infos des membres ensuite via les Friendlyname :
Si on spécifie uniquement un Id => Le membre aura les coordonnées du contact ou du Docageuser correspondant
Si on spécifie un objet contact :
On met à jour le contact s'il contient un Id ou si le TransactionMember avec le même FriendlyName contient un ContactId
On crée un nouveau contact s'il ne contient pas d'Id et si le TransactionMember avec le même FriendlyName ne contient pas un ContactId
On ajoute ensuite le contenu des transactionfiles via FiendlyName et FormFile
3.
Création d'un parcours à partir d'un modèle en utilisant TemplateId :
Avantages : Une requête très simple tout en pouvant modifier les membres, les fichiers et les signatures visuelles
Inconvénients : Ne permet pas de mofifier les propriétés directes du parcours comme les claseurs, le nom, les rappels... dans la même requête
On spécifie un TemplateId avec l'Id du modèle
On modifie les infos des membres que l'on veut modifier ensuite via les Friendlyname :
Si on spécifie uniquement un Id => Le membre aura les coordonnées du contact ou du Docageuser correspondant
Si on spécifie un objet contact :
On met à jour le contact s'il contient un Id ou si le TransactionMember avec le même FriendlyName contient un ContactId
On crée un nouveau contact s'il ne contient pas d'Id et si le TransactionMember avec le même FriendlyName ne contient pas un ContactId
On modifie ensuite le contenu des transactionfiles via FriendlyName et FormFile
On ajoute les signatureLocations ensuite via les friendlyname et un objet transactionMemberSignatureLocation sans Id
4.
Création d'un parcours à partir d'un modèle et je veux modifier ses propriétés directes :
Avantages : On récupère toutes les propriétés du modèle tout en pouvant en modifier certaines, comme les claseurs, le nom, les rappels...
Inconvénients : Nécessite au moins 2 requêtes
Je crée et récupère un parcours à partir d'un modèle en appelant CreateEntityFromTemplate
Je joins le parcours avec la clé Transaction et comme valeur le parocurs complet (sans le contenu des fichiers qui doit être envoyé séparément).
On modifie les infos des membres que l'on veut modifier ensuite via les Friendlyname :
Si on spécifie uniquement un Id => Le membre aura les coordonnées du contact ou du Docageuser correspondant
Si on spécifie un objet contact :
On met à jour le contact s'il contient un Id ou si le TransactionMember avec le même FriendlyName contient un ContactId
On crée un nouveau contact s'il ne contient pas d'Id et si le TransactionMember avec le même FriendlyName ne contient pas un ContactId
On modifie ensuite le contenu des transactionfiles via FriendlyName et FormFile
On ajoute les signatureLocations ensuite via les friendlyname et un objet transactionMemberSignatureLocation sans Id
Request
Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Query Params
Responses
🟢200OK
application/json
OK
Body
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request POST '/Transactions/CreateFullTransaction?launchTransaction' \
--header'Authorization: Basic <encoded-value>'