Parcours

Une fiche « Parcours », telle que l'API la lit et l'écrit (Transaction dans la référence). Sa liste et sa création : https://staging-api.docage.com/Transactions ; une fiche : https://staging-api.docage.com/Transactions/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.

Ses propriétés

• AbsenceIdidentifiantÉcrite par le serveur

  Identifiant de l'absence

• AutomaticReminderSententierÉcrite par le serveur

  Rappels automatiques envoyés

• CompletionEmailBodytexte

  Corps de l'email de finalisation

• CompletionEmailSubjecttexte

  Sujet de l'email de finalisation

• CreditReportLinesConsumedliste de CreditReportLine

  Lignes de rapport de crédit consommées

• DaysBeforeEndingentier

  Le délai de validité du parcours, en jours. Ignoré quand une date de fin (EndDate) est donnée.

• EndDatedate et heure (UTC)

  Date de fin

• Fieldsliste de Field

  Champs

• FormEmailBodytexte

  Corps de l'email de formulaire

• FormEmailSubjecttexte

  Sujet de l'email de formulaire

• FormIdidentifiant

  Identifiant du formulaire de parcours

• FormReminderEmailBodytexte

  Corps de l'email de rappel de formulaire

• FormReminderEmailSubjecttexte

  Sujet de l'email de rappel de formulaire

• FormResultRedirectUrltexte

  Redirection après formulaire

• FormStatusActionStatus

  Statut des formulaires

• GlobalStatusTransactionGlobalStatusÉcrite par le serveur

  Statut global

• GrossMarginnombre

  Marge brute

• IdentityVerificationStatusActionStatus

  Statut des vérifications d'identité

• Instancesliste de Transaction

  Parcours générés à partir de ce modèle

• InvitationEmailBodytexte

  Corps de l'email d'invitation

• InvitationEmailSubjecttexte

  Sujet de l'email d'invitation

• IsCampaignCompatibleoui ou non

  Compatible avec les campagnes

• IsSignableByMeoui ou non

  Signable par moi

• IsTestoui ou non

  Un parcours d'essai : sans consommation de crédits, aux documents filigranés et sans valeur probante. Le serveur le pose au lancement quand l'organisation n'est pas en production ; il ne change plus une fois le parcours lancé.

• LastMailMainRecipientNametexteÉcrite par le serveur

  Nom du principal destinataire du dernier email

• LastMailStatusMailStatusÉcrite par le serveur

  Statut du dernier email

• LastMailStatusDatedate et heure (UTC)Écrite par le serveur

  Date du statut du dernier email

• LastMailStatusDetailstexteÉcrite par le serveur

  Détails du statut du dernier email

• LastMailSubjecttexteÉcrite par le serveur

  Sujet du dernier email

• MailSettingsTransactionMailSettings

  Paramètres des emails de parcours

• Mailsliste de Mail

  Emails

• MaximumRemindersentier

  Nombre maximum de rappels

• MergeCalculatedFieldsoui ou non

  Fusionner les champs calculés

• MergeDynamicFieldsoui ou non

  Fusionner les champs dynamiques

• MergeEntitiesliste de MergeEntity

  Entités de fusion

• MergeFormatFieldsoui ou non

  Fusionner les formats

• Nametexte

  Nom du parcours

• NetMarginnombre

  Marge nette

• OrderModeTransactionOrderMode

  Déroulement du parcours

• PaymentStatusActionStatus

  Statut des paiements

• Paymentsliste de Payment

  Les paiements rattachés à ce parcours : les instances de ses actions de type Paiement.

• PersonIdentityVerificationsliste de PersonIdentityVerification

  Les vérifications d'identité rattachées à ce parcours : les instances de ses actions de type Vérification d'identité.

• PipelineItemIdidentifiant

  Identifiant de la carte

• PreFillDocumentsoui ou non

  Pré-remplir les documents

• PurchaseCostesnombre

  Coûts d'achat

• PurchasePricenombre

  Prix d'achat

• PurchasePriceWithCostesnombre

  Prix d'achat avec coûts

• RedirectionTargetRedirectionTarget

  Ouverture de la redirection

• RefusalEmailBodytexte

  Corps de l'email de refus

• RefusalEmailSubjecttexte

  Sujet de l'email de refus

• ReminderReminder

  Fréquence des rappels

• ReminderEmailBodytexte

  Corps de l'email de rappel

• ReminderEmailSubjecttexte

  Sujet de l'email de rappel

• RequiredIdentityLevelPersonIdentityAssuranceLevel

  Le niveau de vérification d'identité que tout signataire de ce parcours doit avoir atteint pour signer, sur l'échelle de PersonIdentityAssuranceLevel : None = aucune exigence. Réglé sur le modèle de parcours, recopié sur le parcours ; un participant peut exiger davantage (son RequiredIdentityLevel), et le plus exigeant des deux s'applique. Le serveur le fait respecter au lancement — chaque signataire porte une action de vérification dont les contrôles y mènent, ou une identité déjà vérifiée à ce niveau — et à la signature, sur ce que la vérification a réellement rendu : une session qui n'a lu que la pièce n'atteint pas « Pièce et vivant ». Nfc n'est rendu par aucun fournisseur et n'est pas proposé.

• ResultPagesWebPageResultPages

  Les écrans de fin du parcours, une page par issue : ils remplacent, pour ses participants, ceux des préférences ; un participant peut s'en écarter (son ResultPages). Une URL de redirection posée par un intégrateur, sur le participant ou sur le parcours (SignResultRedirectUrl, ValidationResultRedirectUrl, FormResultRedirectUrl), passe avant. Une page qui n'est pas un modèle actif de cette sorte et de cette issue, de l'organisation du parcours ou système, est ignorée : le niveau suivant prend le relais.

• SalePricenombre

  Prix de vente

• SalePriceWithTaxesnombre

  Prix de vente avec taxes

• SaleTaxesnombre

  Taxes de vente

• SignResultRedirectUrltexte

  Redirection après signature

• SignatureEmailBodytexte

  Corps de l'email de signature

• SignatureEmailSubjecttexte

  Sujet de l'email de signature

• SignatureStatusActionStatus

  Statut des signatures

• SmsMessagesliste de SmsMessage

  Les SMS envoyés pour ce parcours — ses codes de sécurité, et ceux qu'un flux envoie quand il agit sur lui —, comme Mails pour les emails.

• StartDatedate et heure (UTC)Lecture seule

  Date de départ

• TemplateTransaction

  Modèle de parcours

• Timestampsliste de Timestamp

  Les horodatages rattachés à ce parcours : jetons du scellement (journal) et horodatages demandés depuis ses fichiers.

• TransactionActionsliste de TransactionAction

  Actions

• TransactionFilesliste de TransactionFile

  Documents

• TransactionMembersliste de TransactionMember

  Participants

• TransactionObserversliste de TransactionObserver

  Observateurs

• ValidationResultRedirectUrltexte

  Redirection après validation

• ValidationStatusActionStatus

  Statut des validations

Aucune propriété ne correspond.

Ses énumérations

Ses liaisons

Les fiches auxquelles elle se lie, et le rôle de chacune : ce que LinkedToTypeName et LinkedToId retrouvent dans une liste (voir Lire des listes).

• AbsenceAbsence
• CampagneCampagne qui l'instancie
• CarteCarte
• ClasseurClasseur
• ContactParticipantObservateur de parcours
• DocumentDocument produitDocument choisiDocument de travail
• EmailParcours
• FormulaireAction de parcours
• HorodatageParcours
• Message WhatsAppParcours
• Modèle de code de sécuritéAction de parcours
• Page webÉcran de fin
• PaiementParcoursAction de parcours
• ParcoursModèle de parcours
• Politique de marqueModèle de parcours d'abonnement
• RéservationAction de parcours
• SMSParcours
• Type d'absenceModèle de parcours d'approbation
• UtilisateurParticipantObservateur de parcours
• Vérification d'identitéParcoursAction de parcours
• ÉvénementParcours