POST api/v2/packageservice/create
Request Information
URI Parameters
None.
Body Parameters
PackageRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Description |
Beschrijving, deze wordt gebruikt om als naam van het pakket weer te geven in het webSigner Portaal. |
string |
None. |
| Initiator |
Email adres, gekende gebruiker van het webSigner portaal. |
string |
None. |
| CallBackUrl |
Web URL welke wordt opgeroepen telkens een handteken wordt gezet op een document; als er geen URL is voorzien, wordt geen antwoord teruggestuurd (vb. http:\\[server]\callback). |
string |
None. |
| ExpiryTimestamp |
Datum wanneer document komt te vervallen |
date |
None. |
| ExternalReference |
Referentie meegegeven door de aanroepende applicatie, deze parameter wordt niet gebruikt door het webSigner portaal. |
string |
None. |
| RedirectUrl |
URL naar waar de eindgebruiker wordt gestuurd na ondertekenen. Dit veld moet een geldige absolute URL zijn. |
string |
None. |
| SendNotifications |
Bepaalt of er automatisch een email moet worden verstuurt naar de ondertekenaars als de status van de package op PENDINGSIGNING wordt gezet. |
boolean |
None. |
| Label1 |
Optional parameter. |
string |
None. |
Request Formats
application/json, text/json
{
"description": "sample string 1",
"initiator": "sample string 2",
"callBackUrl": "sample string 3",
"expiryTimestamp": "2026-04-30T09:36:04.0057059+02:00",
"externalReference": "sample string 4",
"redirectUrl": "sample string 5",
"sendNotifications": true,
"label1": "sample string 6"
}
text/plain
{"description":"sample string 1","initiator":"sample string 2","callBackUrl":"sample string 3","expiryTimestamp":"2026-04-30T09:36:04.0057059+02:00","externalReference":"sample string 4","redirectUrl":"sample string 5","sendNotifications":true,"label1":"sample string 6"}
Response Information
Resource Description
CreateDocumentbundleResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Url | string |
None. |
Response Formats
application/json, text/json
{
"id": "932ae749-fedd-4af7-a993-51e208b5be34",
"name": "sample string 2",
"url": "sample string 3"
}
text/plain
{"id":"932ae749-fedd-4af7-a993-51e208b5be34","name":"sample string 2","url":"sample string 3"}