Login
    Contenu x
    Rapport d’achèvement
    • 18 Nov 2024
    • 12 Minutes à lire
    • Sombre
      Lumière
    • PDF
    Contenu

    Rapport d’achèvement

    • Mis à jour le 18 Nov 2024
    • 12 Minutes à lire
    • Sombre
      Lumière
    • PDF
    Résumé de l’article

    Java SDK.NET SDKREST APIAPEX SDK

    Java SDK

    Pour télécharger l’exemple de code complet, consultez notre site Code Share .

    Il est fortement recommandé d’utiliser un Callback Listener au lieu d’interroger les statuts des transactions. L’utilisation de l’interrogation peut consommer des ressources inutiles de votre côté et du service OneSpan Sign.

    Un rapport d’achèvement contient des informations sur vos expéditeurs, leurs packages associés et leur état.

    Récupération d’un rapport d’achèvement

    Vous pouvez récupérer le rapport d’achèvement à l’aide du service de rapport OneSpan Sign. Vous aurez besoin de l’état du paquet et de la plage de dates que vous souhaitez récupérer.

    // Download the completion report for all senders
CompletionReport sdkCompletionReport = eslClient.getReportService().downloadCompletionReport(PackageStatus.DRAFT, from, to);

if (sdkCompletionReport == null) {
    System.out.println("\nNo packages in DRAFT folder");
} else {
    // Display package id and name of packages in DRAFT from sender
    System.out.println();
    for (SenderCompletionReport senderCompletionReport : sdkCompletionReport.getSenders()) {
        System.out.print("Sender: " + senderCompletionReport.getSender().getEmail());
        System.out.println(" has " + senderCompletionReport.getPackages().size() + " packages in DRAFT");
        for (PackageCompletionReport packageCompletionReport : senderCompletionReport.getPackages()) {
            System.out.println(packageCompletionReport.getId() + " , " + packageCompletionReport.getName() + " , Sender : " + eslClient.getPackage(new PackageId(packageCompletionReport.getId())).getSenderInfo().getEmail());
        }
    }
}

    Cet exemple de code effectuera une recherche dans chaque rapport d’achèvement de l’expéditeur et renverra ce qui suit :

    • l’email de l’expéditeur

    • le nombre de paquets dans un statut DRAFT

    • l’identifiant du paquet et le nom de chaque paquet dans un statut DRAFT .

    Vous pouvez également télécharger ce rapport au format CSV, à l’aide du code suivant :

    // Download the completion report as a CSV for all senders
String sdkCompletionReportCSV = eslClient.getReportService().downloadCompletionReportAsCSV(PackageStatus.DRAFT, from, to);

    Résultats

    Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.

    Kit de développement logiciel (SDK) .NET

    Pour télécharger l’exemple de code complet, consultez notre site Code Share .

    Il est fortement recommandé d’utiliser un Callback Listener au lieu d’interroger les statuts des transactions. L’utilisation de l’interrogation peut consommer des ressources inutiles de votre côté et du service OneSpan Sign.

    Un rapport d’achèvement contient des informations sur vos expéditeurs, leurs packages associés et leur état.

    Récupération d’un rapport d’achèvement

    Vous pouvez récupérer le rapport d’achèvement à l’aide du service de rapport OneSpan Sign. Vous aurez besoin de l’état du paquet et de la plage de dates que vous souhaitez récupérer.

    // Download the completion report for all senders
CompletionReport sdkCompletionReport = eslClient.ReportService.DownloadCompletionReport(PackageStatus.DRAFT, from, to);

if (sdkCompletionReport == null) {
    Debug.WriteLine("\nNo packages in DRAFT folder");
} else {
    // Display package id and name of packages in DRAFT from sender
    Debug.WriteLine("");
    foreach (SenderCompletionReport senderCompletionReport in sdkCompletionReport.Senders) {
        Debug.WriteLine("Sender: " + senderCompletionReport.Sender.Email);
        Debug.WriteLine(" has " + senderCompletionReport.Packages.Count + " packages in DRAFT");
        foreach (PackageCompletionReport packageCompletionReport in senderCompletionReport.Packages) {
            Debug.WriteLine(packageCompletionReport.Id + " , " + packageCompletionReport.Name + " , Sender : " + eslClient.GetPackage(new PackageId(packageCompletionReport.Id)).SenderInfo.Email);
        }
    }
}

    Cet exemple de code effectuera une recherche dans chaque rapport d’achèvement de l’expéditeur et renverra ce qui suit :

    • l’email de l’expéditeur

    • le nombre de paquets dans un statut DRAFT

    • l’identifiant du paquet et le nom de chaque paquet dans un statut DRAFT .

    Vous pouvez également télécharger ce rapport au format CSV, à l’aide du code suivant :

    // Download the completion report as a CSV for all senders
String sdkCompletionReportCSV = eslClient.ReportService.DownloadCompletionReportAsCSV(PackageStatus.DRAFT, from, to);

    Résultats

    Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.

    REST API

    Pour télécharger l’exemple de code complet, consultez notre site Code Share .

    Il est fortement recommandé d’utiliser un Callback Listener au lieu d’interroger les statuts des transactions. L’utilisation de l’interrogation peut consommer des ressources inutiles de votre côté et du service OneSpan Sign.

    Un rapport d’achèvement contient des informations sur vos expéditeurs, leurs packages associés et leur état.

    Récupération d’un rapport d’achèvement

    Vous pouvez récupérer le rapport d’achèvement à l’aide du service de rapport OneSpan Sign. Vous aurez besoin de l’état du paquet et de la plage de dates que vous souhaitez récupérer.

    Requête HTTP

     GET /api/reports/completion?status={status}&from={date}&to={date}

    En-têtes HTTP

    Accept: application/json   
Content-Type: application/json

    Charge utile de réponse

    {
  "from": "2017-11-15T00:00:00Z",
  "senders": [
    {
      "sender": {
        "status": "ACTIVE",
        "language": "en",
        "signature": {
          "handdrawn": "AQAAADJI+a4cnf0t3Dlf0GqWJceCA+4AAwADAN8BAAADAAAAggPuAOgAAAACfyxAUkAlQCdAOUA6QDtAHEAtQBtACkAJQBVAFBIyfkA0QBVABkAYQCpAHEAtQC9ALkAtQDxAO0A6QEhAN0AlQCQyTjZAgEBwQIBAoFDSUOFQ8lDiUNJQ0lCiQHBAUCIXGVBSUCVQN1BJUDpQXVA9UE5QLlAuUDpQOVAkm1BhQLZAd0B7QFpAXUBPQTBAHkAdQAtAB2AmYBRgQmCAcJVwmHC5Mh42QFBAkECAQKBAsEDAQNBQ8VDyUPJQ81DTULRQg1ByUEGeIgQ6QDhAJ0AmQCZAFItwbHBtMhdBUCafUGJQcVCSUJFQoUDAQKBAsECBQHNAdEBEQDRABkAFYCdgR2BXYHhgd2CIYIVgdmBDYEJAUUBwQIFAkECwQLBA0EDAQLBAoEBwQGASG0xAc0BnQEhASkArQBxADEAKQAlABkAFMkVKUENQUVBBUGFQYVCRUKJQsVDCUNJQsUDQQKBAkEBwQFJAREAlIllVUHFQUVByUKFQslDSUNJQ9VDlUPZQ1lDWUKVQZVBEUCQyCxivr2BjYGRgdGB1YHZgZmBWYEdgRkAFQClAREBjQJNAk0CzQKNAs0CjQJNAQo9gRWBjYJNgs2DCYNRg1GCkYKRgY2Bkrg==",
          "textual": null
        },
        "id": "ZQI8k6faVoM8",
        "data": {
          "serviceCredentials": "{}",
          "showIntro": false
        },
        "account": null,
        "title": null,
        "external": null,
        "updated": "2016-05-05T19:30:13Z",
        "memberships": [],
        "phone": "+1 201-555-5555",
        "professionalIdentityFields": [],
        "userCustomFields": [
          {
            "id": "policy_number_id",
            "data": null,
            "translations": [
              {
                "description": "Car Insurance Policy Number.",
                "language": "en",
                "id": "",
                "data": null,
                "name": "Policy Number"
              }
            ],
            "value": "",
            "name": ""
          }
        ],
        "locked": null,
        "activated": null,
        "company": "eSignLive",
        "email": "harishaidary@example.com",
        "firstName": "Haris",
        "lastName": "Haidary",
        "type": "MANAGER",
        "name": "",
        "address": null,
        "created": "2016-05-05T19:30:13Z",
        "specialTypes": [],
        "hasDelegates": false
      },
      "packages": [
        {
          "status": "DRAFT",
          "id": "J5Hk-r1nLXx7HIHGcmAGdQGdNI0=","data": {
            "origin": "api"
          },
          "documents": [
            {
              "id": "contract",
              "firstSigned": null,
              "lastSigned": null,
              "completed": null,
              "name": "Sample Contract"
            }
          ],
          "trashed": false,
          "updated": "2017-11-16T16:53:01Z",
          "created": "2017-11-16T15:38:34Z",
          "name": "PHP Application Example",
          "signers": [
            {
              "id": "Signer1",
              "firstSigned": null,
              "lastSigned": null,
              "completed": null,
              "lastName": "Smith",
              "email": "mail72@example.com",
              "firstName": "John"
            },
            {
              "id": "ZQI8k6faVoM8",
              "firstSigned": null,
              "lastSigned": null,
              "completed": null,
              "lastName": "Haidary",
              "email": "harishaidary@example.com",
              "firstName": "Haris"
            },
            {
              "id": "Sender1",
              "firstSigned": null,
              "lastSigned": null,
              "completed": null,
              "lastName": "Smith",
              "email": "mail71@example.com",
              "firstName": "Mike"
            },
            {
              "id": "Signer5",
              "firstSigned": null,
              "lastSigned": null,
              "completed": null,
              "lastName": "Smith",
              "email": "mail32@example.com",
              "firstName": "John"
            }
          ]
        },
        {
          "status": "DRAFT",
          "id": "aJK-4tCe5YQN6K2VDAOQk94jnLA=","data": {
            "senderVisible": false
          },
          "documents": [],
          "trashed": false,
          "updated": "2017-11-16T15:16:04Z",
          "created": "2017-11-16T15:15:42Z",
          "name": "test",
          "signers": [
            {
              "id": "ZQI8k6faVoM8",
              "firstSigned": null,
              "lastSigned": null,
              "completed": null,
              "lastName": "Haidary",
              "email": "harishaidary@example.com",
              "firstName": "Haris"
            }
          ]
        },
        {
          "status": "OPTED_OUT",
          "id": "r1KxVEVhWgnKVZMYkjJR9I6fqjY=","data": {
            "sdk": "Java v11.8",
            "origin": "api"
          },
          "documents": [
            {
              "id": "aee1629e700a37ded7d4e6a9e32335447f8db6fd79bf74e6",
              "firstSigned": null,
              "lastSigned": null,
              "completed": false,
              "name": "test doc"
            }
          ],
          "trashed": false,
          "updated": "2017-11-15T17:49:37Z",
          "created": "2017-11-15T16:13:52Z",
          "name": "Package with Initials and Fullname",
          "signers": [
            {
              "id": "Signer1",
              "firstSigned": null,
              "lastSigned": null,
              "completed": false,
              "lastName": "Smith",
              "email": "mail32@example.com",
              "firstName": "John"
            },
            {
              "id": "ZQI8k6faVoM8",
              "firstSigned": null,
              "lastSigned": null,
              "completed": null,
              "lastName": "Haidary",
              "email": "harishaidary@example.com",
              "firstName": "Haris"
            }
          ]
        },
        {
          "status": "DRAFT",
          "id": "wkfRigOpypHA2q1HLpHiaTLjoMc=","data": {
            "sdk": "Java v11.8",
            "origin": "api"
          },
          "documents": [
            {
              "id": "5e7c8c233a647df3e61a9d4864f7ebca5fe0f8feeb9b7a72",
              "firstSigned": null,
              "lastSigned": null,
              "completed": false,
              "name": "test doc"
            }
          ],
          "trashed": false,
          "updated": "2017-11-15T16:21:23Z",
          "created": "2017-11-15T16:21:21Z",
          "name": "Package with Initials and Fullname",
          "signers": [
            {
              "id": "ZQI8k6faVoM8",
              "firstSigned": null,
              "lastSigned": null,
              "completed": null,
              "lastName": "Haidary",
              "email": "harishaidary@example.com",
              "firstName": "Haris"
            },
            {
              "id": "Signer1",
              "firstSigned": null,
              "lastSigned": null,
              "completed": false,

    Vous pouvez également télécharger le rapport d’achèvement au format CSV, en définissant l’en-tête Accept sur text/csv :

     GET https://sandbox.esignlive.com/api/reports/completion

    Résultats

    Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.

    APEX SDK

    Pour télécharger l’exemple de code complet, consultez notre site Code Share .

    Il est fortement recommandé d’utiliser un Callback Listener au lieu d’interroger les statuts des transactions. L’utilisation de l’interrogation peut consommer des ressources inutiles de votre côté et du service OneSpan Sign.

    Un rapport d’achèvement contient des informations sur vos expéditeurs, leurs packages associés et leur état.

    Récupération d’un rapport d’achèvement

    Vous pouvez récupérer le rapport d’achèvement à l’aide duservice de rapport OneSpan Sign. Vous aurez besoin de l’état du package, de la plage de dates que vous souhaitez récupérer (aaaa-mm-jj) et de l’ID de l’expéditeur. Cela associera le rapport d’achèvement à un expéditeur spécifique. Pour récupérer un rapport d’achèvement pour tous les expéditeurs, définissez l’ID de l’expéditeur sur null.

    La fonction permettant de récupérer le rapport de fin d’achèvement est encapsulée comme suit :

    // Method to download the completion report
public TestCompletionReport.CompletionReport downloadCompletionReport(
    ESignLiveAPIObjects.PackageStatus packageStatus, 
    String from_x, 
    String to, 
    String senderId
) {
    // Your implementation here
}
    // Download the completion report for sent packages
TestCompletionReport.CompletionReport completionReport = downloadCompletionReport(
    ESignLiveAPIObjects.PackageStatus.SENT, '2018-10-01', null, null
);

// Iterate through the sender completion reports
for (TestCompletionReport.SenderCompletionReport senderCompletionReport : completionReport.senders) {
    System.debug('Sender: ' + senderCompletionReport.sender.email + ' has ' + senderCompletionReport.packages.size() + ' packages in SENT');
    
    // Iterate through the package completion reports for each sender
    for (TestCompletionReport.PackageCompletionReport packageCompletionReport : senderCompletionReport.packages) {
        System.debug('package id: ' + packageCompletionReport.id + ' , package name: ' + packageCompletionReport.name);
    }
}

    Cet exemple de code effectuera une recherche dans chaque rapport d’achèvement de l’expéditeur et renverra ce qui suit :

    • l’email de l’expéditeur

    • le nombre de paquets dans un état SENT

    • l’identifiant du paquet et le nom de chaque paquet dont l’état est ENVOYÉ.

    Vous pouvez également télécharger ce rapport au format CSV, à l’aide du code suivant :

    // Method to download the completion report as a CSV
public Blob downloadCompletionReportAsCSV(
    ESignLiveAPIObjects.PackageStatus packageStatus, 
    String from_x, 
    String to, 
    String senderId
) {
    // Your implementation here
}

    Résultats

    Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.

    Cet article vous a-t-il été utile ?
    What's Next
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout
    ESC

    Ozzy, facilitant la découverte de connaissances grâce à l’intelligence conversationnelle