5.15 Package Expiry Extension
5.15.1 Description
A package may have the status Expired when a package passed a value for the ExpiryTimestamp parameter in the Create Package call. Such a package can no longer be approved or signed.
The “extend expiry” call allows to specify a new date and time in the future on which the package will expire, thus allowing it to be approved/signed again until that date and time.
An expiration timestamp can currently be set on a package which has the status Draft, Expired or Pending. An expiration timestamp cannot be removed once set, but it is possible to choose a date and time far in the future instead.
5.15.2 URL
https://[servername]:[port]/webportalapi/v3/packages/{id}/expirytimestamp
5.15.3 HTTP Method
PUT
5.15.4 MIME Type
application/json
5.15.5 Template parameters
Parameter | Occurrence | Content / Description | Type |
---|---|---|---|
Id | Required | Unique id for the signing package | String |
5.15.6 Request parameters
Parameter | Occurrence | Content / Description | Type |
---|---|---|---|
ExpiryTimestamp | Required | The new date and time when this package expires. This must be an ISO 8601 date-time. E.g. 2018-01-23T12:34:00.000Z |
Date-time |
5.15.7 Example request
{
"ExpiryTimestamp": "{{eSigner - FutureDate}}"
}
5.15.8 Response parameters
Parameter | Content / Description | Type |
---|---|---|
None | Empty response body |
5.15.9 Example response
Successful response
{}
5.15.10 Response codes
Response status code | Description |
---|---|
200 OK | The update package expiry timestamp was set. |
400 Bad request | The request contained parameters which could not be accepted. |
400 Not Found | The package id could not be found in the database. |
409 Conflict | When the status of the document does not allow to extend the expiration period. |
5.15.11 Error codes
HTTP code | Code |
---|---|
400 | Package.ExpiryTimestampInvalid |
400 | Package.ExpiryTimestampIsRequired |
404 | Package.NotFound |
409 | Package.InvalidStatus |