Récupération d’une liste de transactions

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.

Récupération de la transaction dans les plages de dates spécifiées

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

La première étape de la récupération d’une liste de transactions qui se trouvent dans une plage de dates spécifiée consiste à définir la plage de dates. Pour ce faire, le code suivant :

Date START_DATE = new LocalDateTime(2016, 1, 1, 0, 0).toDate(); //January 01 2016, 00:00 EST
Date END_DATE = LocalDateTime.now().toDate();

Ensuite, vous pouvez récupérer vos transactions dans cette plage de dates, triées par statut. Par exemple, COMPLETED, DRAFT, ARCHIVED, SENT et DECLINED). Pour ce faire, le code suivant :

Page<DocumentPackage> draftPage = eslClient.getPackageService().getUpdatedPackagesWithinDateRange(PackageStatus.DRAFT, new PageRequest(1), START_DATE, END_DATE);

Récupération d’une liste d’ID de transaction

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

La récupération d’une liste d’ID de transaction renvoie un objet Page contenant une liste de types de carte, chaque type de carte contenant l’ID de package.

Pour ce faire, le code suivant :

		PageRequest pageRequest = new PageRequest(1, 100);
		Boolean hasNext = false;
		do {
		    Page<Map<String, String>> packages = eslClient.getPackageService().getPackagesFields(PackageStatus.COMPLETED,
		            pageRequest, Sets.newHashSet("id"));
		    hasNext = packages.hasNextPage();
		    pageRequest = pageRequest.next();
		     
		    List<Map<String,String>> results = packages.getResults();
		    for (Map<String, String> map : results) {
		        String packageId = map.get("id");
		        System.out.println(packageId);
		    }
		     
		} while (hasNext);

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.

Récupération de la transaction dans les plages de dates spécifiées

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

La première étape de la récupération d’une liste de transactions qui se trouvent dans une plage de dates spécifiée consiste à définir la plage de dates. Pour ce faire, le code suivant :

DateTime START_DATE = DateTime.Now.AddDays(-100); //Retrieve packages for last 100 days
DateTime END_DATE = DateTime.Now;

Ensuite, vous pouvez récupérer vos transactions dans cette plage de dates triées par statut. Par exemple, COMPLETED, DRAFT, ARCHIVED, SENT et DECLINED). Pour ce faire, le code suivant :

Page<DocumentPackage> draftPage = eslClient.PackageService.GetUpdatedPackagesWithinDateRange(DocumentPackageStatus.DRAFT, new PageRequest(1), START_DATE, END_DATE);

Récupération d’une liste d’ID de transaction

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

La récupération d’une liste d’ID de transaction renvoie un objet Page contenant une liste de types de carte, chaque type de carte contenant l’ID de package.

Pour ce faire, le code suivant :

            PageRequest pageRequest = new PageRequest(1, 100);
            bool hasNext = false;
            do
            {
                Page<Dictionary<String, String>> packages = eslClient.PackageService.GetPackagesFields(DocumentPackageStatus.COMPLETED,
                        pageRequest, new HashSet<String>() { "id" });
                hasNext = packages.HasNextPage();
                pageRequest = pageRequest.Next;
                IList<Dictionary<String, String>> results = packages.Results;
                foreach (var map in results)
                {
                    String packageId = map["id"];
                    Debug.WriteLine(packageId);
                }
            } while (hasNext);

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.

Récupération de la transaction dans les plages de dates spécifiées

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

La première étape de la récupération d’une liste de transactions qui se trouvent dans une plage de dates spécifiée consiste à définir la plage de dates. Pour ce faire, le code suivant :

Requête HTTP

GET /api/packages?query={status}&startDate={date}&endDate={date}

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Les objets JSON de chaque transaction vous seront renvoyés. Voici les valeurs possibles pour chaque paramètre :

Charge utile de réponse

{
  "results": [
  		{
  		    "id": "mC3p1FENigGItiL3Zmojtr64e0Y=","status": "DRAFT",
		    "description": "",
		    "language": "en",
		    ...
  		},
  		{...},
  		{...},
  		...
   ],
  "count": 216

}

• REQUÊTE : ARCHIVÉE, TERMINÉE, BROUILLON, ENVOYÉE, EXPIRÉE, OPTED_OUT ET REFUSÉE.

• startDate : Utilisé pour la pagination.

• endDate : Utilisé pour la pagination. (Remarque : un maximum de 100 transactions peut être retourné)

Récupération d’une liste d’ID de transaction

C’est le code suivant qui le fera. Notez ce qui suit :

• champs: La seule valeur disponible est « id ».

Requête HTTP

GET /api/packages?query={status}&startDate={date}&endDate={date}&fields=id

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Charge utile de réponse

{
    "results": [
        {
            "id": "uchWJej65gbJsVaWmibQHGc8_rA="
        },
        {
  "id": "jUfE05dJsa6d3A_oYxixt0gf2SI="
        },
        ...
    ],"count": 216
}

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.

Récupération d’une liste de transactions

Vous pouvez récupérer une liste de transactions en passant une carte des paramètres de requête.

public List<ESignLiveAPIObjects.Package_x> getPackages(Map<String,String> queryParameters)

Par exemple:

List < ESignLiveAPIObjects.Package_x > packages = new TestRetrievePackagesWithinDateRanges().getPackages(new Map<String, String> {
	'lastUpdatedStartDate' => '2023-11-01', 'lastUpdatedEndDate' => '2023-11-10', 'from' => '1', 'to' => '100', 'query' => 'SENT'
});

requête: ARCHIVÉ, TERMINÉ, BROUILLON, ENVOYÉ, EXPIRÉ, OPTED_OUT ET REFUSÉ.

De: Utilisé pour la pagination.

À: Utilisé pour la pagination. (Remarque : un maximum de 100 colis peut être retourné)

Date de début : La date de début de la récupération des transactions (par exemple, 2023-01-01)

Date de fin : La dernière date à laquelle les transactions doivent être récupérées (par exemple, 2023-12-31).

champs: La seule valeur disponible est id.