mikcanf | Posts: 71

Pkg status's

Thursday, October 1, 2020 at 11:22am
0 votes

Hi there; my understanding has been there are 7 status's (Draft, In Progress[sent], Completed, Opted out, Declined, Archived and Trashed)

Does "Expired" count as a status? ( it's not included on OneSpan Account Summary report ).

I notice the (7) status's usually appear as 4th item in JSON, just before roles[] but "Expired" status shows up further in the JSON, after roles[], is this a new/different status field?  Why has it same name but different position in JSON.

Please provide some understanding re above:

Thx!

Duo_Liang | Posts: 3776

Reply to: Pkg status's

Thursday, October 1, 2020 at 12:49pm
0 votes

Hi Mike,

 

Actually the "Trashed" is not a status, whereas the "EXPIRED" is, see below:

  • DRAFT: The package has not yet been sent.
  • SENT: The package has been distributed for signatures but has not yet been completed.
  • COMPLETED: The package has been signed by all recipients.
  • OPTED_OUT/DECLINED: The package has at least one recipient who has opted out of signing the document(s) electronically or declined to sign the document(s).
  • EXPIRED: The package has expired (its expiry date is in the past).
  • ARCHIVED: The package has been archived.

Trash is an additional flag (package level JSON > "trashed") and packages with this flag will be moved to the Trash folder.

 

OneSpan Sign API response doesn't preserve the order of JSON objects - even if you repeatedly invoke the retrieval API for the same package, the order of fields may vary.

 

In terms of the "OneSpan Account Summary report", does it generated by the reporting APIs, or you simply received it from your CSR / support team?

 

Duo

 

Duo_Liang | Posts: 3776

Reply to: Pkg status's

Thursday, October 1, 2020 at 01:17pm
0 votes

I see. It's a known limitation that in sender UI, Account Summary Report page, packages with "EXPIRED" status are not listed. The original design of this UI is:

 

When you click the "Run Report", the UI was rendered by "Usage Report API", which returns the package numbers of each status for all senders

GET /api/reports/usage?from=2019-10-01&to=2020-10-01

10-1-2

Where you'll find all 7 statuses + trashed packages are covered. However, the expired packages were not included in the UI.

 

Once you chosen a sender and expanded a status, "Completion Report API" will be invoked:
GET /api/reports/completion?senderId=ATQOPd60xE4V&status=sent&from=2019-10-01&to=2020-10-01

 

Duo

 

 

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

LoginSign Up