jingai | Posts: 6

which API call to use to retrieve package ID?

0 votes
Hi, We are planning to implement a purge process to purge packages that's too old. But since the purge API takes package id and we don't have it, should we call Get /packages to get all the package ids that meet our requirements? Is there any other API that returns only package id (but not the package itself) based on our search criteria? Thanks, Jing

harishaidary | Posts: 1812

Reply to: which API call to use to retrieve package ID?

0 votes
Hi Jing, The best option would be to setup a callback listener and store completed package IDs in a database that would allow you to track the date and go back and delete all packages as they become too old. How to register for callback notifications: https://developer.esignlive.com/guides/feature-guides/callback-notifications/ Examples: https://www.esignlive.com/blog/search/callback+listener If you choose not to go that way, you can try the completion report: http://docs.esignlive.com/content/c_integrator_s_guide/rest_api/reports.htm#Retrieve2

jingai | Posts: 6

Reply to: which API call to use to retrieve package ID?

0 votes
Thanks Haris for your quick reply! Will take a look at the callback API. But we have looked at the completion report API, it seems only can give us the package for a particular sender, not the entire account (company), which is what we are looking for. Also, we want to be able to specify multiple status, but the API can only take one status? Thanks, Jing

harishaidary | Posts: 1812

Reply to: which API call to use to retrieve package ID?

0 votes
For the completion report, if you don't specify a specific a sender, then it returns you packages for the entire account (i.e. account owner + senders). For example:
GET https://sandbox.esignlive.com/api/reports/completion?status=draft&from=2017-02-01&to=2017-04-21
And yes, you can only retrieve one status at a time.

jingai | Posts: 6

Reply to: which API call to use to retrieve package ID?

0 votes
Hmm, this is different from what's been documented , here is what I see for this API from this link http://docs.esignlive.com/content/c_integrator_s_guide/rest_api/reports.htm#Retrieve2: senderId-- The records in the report will all be associated with this sender ID. If no value is specified, the default senderId is the last sender in the account that created a package with the same state as that specified by status. Thanks, Jing

harishaidary | Posts: 1812

Reply to: which API call to use to retrieve package ID?

0 votes
That might be a mistake in our documentation. Did you try the call above?

jingai | Posts: 6

Reply to: which API call to use to retrieve package ID?

0 votes
we have not tried yet, but will do. Thanks Haris for your help. Jing

harishaidary | Posts: 1812

Reply to: which API call to use to retrieve package ID?

0 votes
No problem. Let me know if you have further questions.

Hello! Looks like you're enjoying the discussion, but haven't signed up for an account.

When you create an account, we remember exactly what you've read, so you always come right back where you left off