...
and created via .xsd:
| View file | ||
|---|---|---|
|
The svg also contains XML elements which aren't relevant for TyrService upload.
...
XML-Element | webso | Type | description | ||||||
|---|---|---|---|---|---|---|---|---|---|
<Position> | x | Integer | The Position of the condition inside the document. Positions are defined for each condition and document in the envelope. | ||||||
<ConditionType> | x | String | only possible value is "download" | ||||||
<PDF> | x | base64 | A pdf file encoded in base64 to download. Alternativley <DocumentFromPosition> can be defined. | ||||||
<PDFName> | x | String | name of the document to download. | ||||||
<DocumentFromPosition> | x | Integer | Defines which document should be downloaded to fullfill the condition. Necessary if <PDF> is not defined. | ||||||
<DocumentNoBiodata>
| x | Integer 1/0 | Defines if the document should be downloaded with or without the biodata If 1 (true) the downloaded document just contains a pictures of the signatures with the text "copy"/"Kopie" but no certificate and no biodata (signature data).  | ||||||
<InfoText> | x | String | a text shown, when the download popup appears.  | ||||||
<ShowInViewer> | x | Integer 1/0 | If true (1) the download condition with a preview image of the pdf is shown in the viewer.
| ||||||
<SignatureGroupName> | x | String | Defines which signatureGroup has to fullfill the download condition. | ||||||
<UserName> | x | String | Login name of a registered user or an email address. Defines which technical user has to fullfill the download condition. | ||||||
<AfterSigning> | |||||||||
(<finished> / <FinishedXmlDateTime>) | (x) | When a condition is finished and the method retrieveXML is called, <finished> and <FinishedXmlDateTime> will be added to the returned XML. Not applicable at upload time. | |||||||
...
If OptionSMS is true, a phone number can be defined. A SMS will be send with a link to the document.
<SelectionPhoneTabletDetails>:
...
XML-Element | webso | Type | description | ||
|---|---|---|---|---|---|
<QesId><QesProviderId> | x | Integer | The id of the qes service. Either <QesId> <QesProviderId> or <QesProvider> must be provided. currently supported QesProvider:
| ||
<QesProvider> | x | String | The name of the qes service. Either <QesId> or <QesProvider> must be provided. example:
| ||
<UserName> | x | String | The UserName. It is used to map the Qes data of the user to the signature fields. | ||
<Number> | x | Number | The phone number without country code. e.g.: 173 123 123 | ||
<PhoneCode> | x | String | The international phone code of the mobile number according to iso 3166-1 alpha 2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ). e.g. “de” for Germany |
...
XML-Element | webso | Type | description |
|---|---|---|---|
<SignatureGroupName> | x | String | Defines the name of the signatureGroup. (mandatory) |
<ShowSignatureTypePopUp> | x | Integer 1/0 | defines if the signatureTypePopup is shown. If 1 (true), the signatureTypePopup will be shown. Note: If <ShowSignatureTypePopUp> is true, <ShowSignatureTypePopUpDetails> must be defined! (see below) |
<ShowSignatureTypePopUpDetails> | x | With the tag <ShowSignatureTypePopUpDetails> and it's child tags <SelectionPad>, <SelectionPhoneTablet>, <SelectionDisplay> (all int's with 1 or 0 values) the SignatureTypePopUp can be defined showing all or just some of the signature type selections.
Note:
| |
<SignatureFieldColor> |
...