Rapport d’utilisation

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

Le rapport d’utilisation affiche, pour chaque expéditeur, le nombre de paquets qui se trouvent dans chaque état possible (par exemple, BROUILLON, ENVOYÉ, TERMINÉ).

Récupération d’un rapport d’utilisation

Vous pouvez récupérer le rapport d’utilisation à l’aide du service de rapport OneSpan Sign. Vous aurez besoin de la plage de dates que vous souhaitez récupérer.

// Download the usage report for the specified date range
UsageReport report = client.getReportService().downloadUsageReport(from, to);

Les rapports d’utilisation de l’expéditeur vous sont renvoyés sous forme de liste. Vous devrez parcourir chaque rapport d’utilisation de l’expéditeur. Pour ce faire, un itérateur est utilisé pour récupérer le nombre de packages dans chaque statut de package dans votre plage de dates. En outre, pour chaque rapport d’utilisation de l’expéditeur, le prénom et le nom de famille sont générés dans la console.

// Get the list of sender usage reports
List<SenderUsageReport> senderReports = report.getSenderUsageReports();

for (SenderUsageReport senderReport : senderReports) {
    // Print the sender's name
    System.out.println("\nSender \"" + senderReport.getSender().getFirstName() + " " + senderReport.getSender().getLastName() + "\" has: \n");

    // Get the usage report categories and their counts
    EnumMap<UsageReportCategory, Integer> usageReportCategory = senderReport.getCountByUsageReportCategory();
    Iterator<UsageReportCategory> enumKeySet = usageReportCategory.keySet().iterator();

    // Iterate through the usage report categories and print the counts
    while (enumKeySet.hasNext()) {
        UsageReportCategory currentUsageReportCategory = enumKeySet.next();
        System.out.println(usageReportCategory.get(currentUsageReportCategory) + " packages in " + currentUsageReportCategory + " status");
    }
}

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

// Download the usage report as a CSV for the specified date range
String reportCSV = client.getReportService().downloadUsageReportAsCSV(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 .

Le rapport d’utilisation affiche, pour chaque expéditeur, le nombre de paquets qui se trouvent dans chaque état possible (par exemple, BROUILLON, ENVOYÉ, TERMINÉ).

Récupération d’un rapport d’utilisation

La récupération d’un rapport d’utilisation se fait en effectuant la requête suivante :

Requête HTTP

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

En-têtes HTTP

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

Vous devrez passer en paramètre la plage de dates que vous souhaitez récupérer. Ensuite, vous devrez parcourir chaque rapport d’utilisation de l’expéditeur individuel dans la réponse JSON afin de récupérer le nombre de packages dans l’état de chaque package. Dans l’exemple de code ci-dessous, un itérateur est utilisé pour parcourir la réponse JSON.

Charge utile de réponse

{
  "from": "2017-11-17T00: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": {
        "draft": 1
      }
    },
    {
      "sender": {
        "status": "ACTIVE",
        "language": "en",
        "signature": {
          "handdrawn": "AQAAAMNxCV9Bvmy34F4trFmJ21OCA+4AAwADAFgBAAADAAAAggPuAKQAAAACdSdASkGLQB9BAEEYQAhgFWAUEhF8j0CNQZ9BMUJAQCxAJzJLK0B0QIFAwlQCVEJUVFgHUPNQgTIKNGCEYGdgfGCOYFthR2FEQUhAiUDnRCJUgVRHVZRRslFGUQZxonUAdFp0RGSRYOhgm2BeYD9APEDHQJFQcRJQPEBJQCtBIUElQnRBMkAsQCVQYVB2ULVQ1VD0UOZUpUDTQLFAUUA0MH5QC1AfUC5RI1FBUuZQSFSBQYBBZUFjQU1BAEAsQCdgJHDIcGQyUBxAgEDQUPFUQlRhVHNUElD2UHKbMgYtQGFA4FChVGJYhFSEVBFQcUAGYEpgrGCpYMdgtWD3YIRgZGBCYEMyMzSPQEJAaECoQIZAhUCFQMhAVo4iFA+vYDlgKUAXQHRAg1QGUEVQR3A2cIhw13DEcMFgYmBEYCpACEBFQIdAhECRUHFQQw==",
          "textual": null
        },
        "id": "E5b38STIWcMI",
        "data": {
          "serviceCredentials": "{}",
          "showIntro": false
        },
        "account": null,
        "title": null,
        "external": null,
        "updated": "2016-05-10T14:24:46Z",
        "memberships": [],
        "phone": "",
        "professionalIdentityFields": [],
        "userCustomFields": [],
        "locked": null,
        "activated": null,
        "company": "ESIGN",
        "email": "price9872@gmail.com",
        "firstName": "Johnny",
        "lastName": "Cash",
        "type": "REGULAR",
        "name": "",
        "address": null,
        "created": "2016-05-10T14:24:46Z",
        "specialTypes": [],
        "hasDelegates": false
      },
      "packages": {}
    },
    {
      "sender": {
        "status": "ACTIVE",
        "language": "en",
        "signature": {
          "handdrawn": "AQAAANJsTUwxfNU+Ldhp6TyKit+CA+4AAwADAPYCAAADAAAAggPuAH4BAAACeCZgFUAHQAhABUAGQAdAB2AZYChgGGAZQAlACkAIQAlAB2AVQAcSC4JANEAVQAVAFUAXQAZAJkAWQCdARkA0QESOQGNAYUBxQIBAgECAUIJQc1BkUFVQVlA4UClQGVAIUAdwFnAVu3AkvmBQYENgRWA3YCpgLGA+YC5gLWAdQAtACUAIQAZAJUA2j0BBn1AFUBZQBxIUOFAlUDSbUFaeUEJQYVBhQHBAkEC2QLdAyUC5QIhAd0BGQBVABUAFYDVgZmBkYIVghWB0YJVgY2B0YHJgUmBBYGFwgr9wRHBEcEVwNXA0cDVwF1AHUCSfUERQU1BSUEFQoUBgQHBAkUByQJNAg0CCQHJAUkBRQIBAcFBSUEJQRJtQBTIVOUAkQCZAN0BJQDhAW0BaQFpASUBZQEdAJkAkQCRQBnA1cDZwVnBncGdwZ3BWcDVwNnAmcBVQBlAFUCZQJJ9QRFBEUGNQUlBSUFFQUlBhAhAZQAhACEAJQCdANkA0QFRAgUBgQGBAYFBzUGRQdlBHUDpQKFAZUAlQB1AGcCVwNGBRQApACUAaQExAG0BNQE1ATUBrQHpAiEB0QHRAU45gkGBwYIFgwGDQYOBkAGQCYOJg4mChYJJgYGBwcEK/cCSbUGJQQVBBErB7QAhAFkAYQCpAGEAaQClAGkAZQBdAJ0AFQBQSAnaeQIBAskCCQINAs0CkQKNAtUCkQKVAlECVQHVAdkBUQEZAJEAGQAVAB2A2YFZgdmCVYKVgtGC1YMNgw2CyYMFgoWCgYJBgcGBwYGBgUHBxcEESsjRgcGBRYFSvYDRgJWAnYBZAB0AGQBhANI9AREBSQGFAYEBgQFBQUlBTn1BEUBRQBVAGcBVwNnA1cDRwNHBFcES/cEK+cFFwQWBQrwJBF1Bz

Vous pouvez également télécharger le rapport d’utilisation au format CSV en définissant l’en-tête Accept sur text/csv.