API call to retrieve package documents
Monday, May 8, 2023 at 04:54pmRe API documentation I expect ALL documents associated with given Package will be returned in Zipfile from this call ->api/packages/{packageId}/documents/zip call
During testing only two Documents were returned; a) Electronic Disclosures and Signature Consent Letter, and b) my own Form.
Why was Evidence Summary document not included as a Zipped form? How can I get Evidence Summary included in returned Zipfile?
Reply to: API call to retrieve package documents
Tuesday, May 9, 2023 at 09:04amHi mike,
It's expected that the Evidence Summary won't be included in this API call (GET /api/packages/{packageId}/documents/zip). But you can definitely download evidence summary via an additional API (GET /api/packages/{packageId}/evidence/summary), then put all documents in a zip file programmatically.
Which programming language are you using? I have some Java code examples for your reference.
Duo
Reply to: API call to retrieve package documents
Tuesday, May 9, 2023 at 10:43amThx Duo. Does GET evidence summary return document in Zip format, or non-Zip format? Inefficient to download multiple documents, in separate Zipfiles, unZip them, then re-Zip all documents as a single Zipfile.
I need to archive(download) Transaction related information. I was advised by OneSpan to capture all Documents relating to given Transaction. I may also need some amount of Transaction metadata to drive index/lookup for users to find Transactions by various key values, e.g. Sender name, Sender Email address, Signer names, Signer Email addresses, as well as Transaction name, Transaction Closedate, and possibly internal Transaction ID value.
It would be great to have a single REST API call for download/archive purposes as this activity would likely be a generic need across all OneSpan Sign users.
It seems there are still API calls not mentioned in (REST) API documentation, could you please let us (OneSpan Sign Users) know all REST API calls as it is very inefficient to discover unknown calls on a "one by one" basis.
Reply to: API call to retrieve package documents
Tuesday, May 9, 2023 at 10:56amHi Duo,examples in both .NET and Java would be appreciated!
Reply to: API call to retrieve package documents
Tuesday, May 9, 2023 at 11:45amHi mike,
The attached is the equivalent code for .Net.
In terms of querying transactions,
Sender email can be filtered by the parameter: GET /api/packages?from=1&to=100&[email protected]
Transaction name, signer f/lname, signer email, can be searched by keyword (you can only have one search keyword): GET /api/packages?from=1&to=100&[email protected]
Transaction Closedate could be related to the latest updated date: GET /api/packages?from=1&to=100&lastUpdatedStartDate=2023-01-01&lastUpdatedEndDate=2023-05-09
(Note that there are some post completion events which can still update this date even if the transaction has been completed, e.g. Archive/Trash/Restore)
Duo