5.6 Set Package Status
5.6.1 Description
By means of the Set Package Status call, you can change the status of a package.
The available statuses are:
- Pending
- Revoked
Pending
Once the package is created and filled with documents, the status needs to be changed to “Pending”. This will make the package visible for each of the stakeholders in their Signer Portal.
Revoked
When a package has the status “Pending” but you want to delete it, you must first change the status to “Revoked”. This make the package unavailable for signing.
If the package was created with the SendNotifications parameter set to true, then all signers will get a notification that they can no longer approve/sign the specified package.
5.6.2 URL
https://[servername]:[port]/webportalapi/v3/packages/{id}/status
5.6.3 HTTP Method
PUT
5.6.4 MIME Type
application/json
5.6.5 Template parameters
Parameter | Occurrence | Content / Description | Type |
---|---|---|---|
id | Required | Unique id for the signing package | String |
5.6.6 Request parameters
Parameter | Occurrence | Content / Description | Type |
---|---|---|---|
Status | Required | Pending Revoked |
String |
5.6.7 Example request
In this example we set the status of the package to "Pending", making it available for signing.
{
"Status": "Pending"
}
5.6.8 Response parameters
The response is currently the same as that of the Get Package Status call. See section 5.8.
5.6.9 Response codes
Response status code | Description |
---|---|
200 OK | The package was successfully changed to the new status. |
400 Bad Request | When invalid parameters are passed. |
404 Not Found | When an unknown package id is passed. |
409 Conflict | When the package doesn't contain any documents or the status doesn't allow revocation. |
5.6.10 Error codes
HTTP Code | Code |
---|---|
400 | Request.RequiredFieldIsMissing |
403 | User.PermissionDenied |
404 | Package.NotFound |
409 | Package.InvalidStatus |
409 | Package.ApiVersionMismatch |
409 | Package.ContainsNoDocuments |
409 | Package.ContainsDocumentWithNoSigners |