RSign (preview)
RSign® is een veilig, juridisch bindend e-handtekeningplatform dat documentwerkstromen stroomlijnt. Met deze connector kunnen gebruikers het verzenden van handtekeningaanvragen automatiseren, de realtime envelopstatus bijhouden en voltooide ondertekende documenten en handtekeningcertificaten ophalen. Het verbetert de bedrijfsefficiëntie door documentuitvoering te digitaliseren en veilige, traceerbare digitale transacties te garanderen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | RSign-ondersteuning |
| URL | https://rsign.com/contact/questions |
| E-mailen | support@rpost.com |
| Connector-metagegevens | |
|---|---|
| Uitgever | RPost US Inc |
| Uitgever | RPost US Inc |
| Webpagina | https://rpost.com/ |
| Privacybeleid | https://rpost.com/legal-notices/privacy-notice |
| Categorieën | Inhoud en bestanden; Productiviteit |
Overzicht van aangepaste RSign-connector
Connectornaam:RSign-beschrijving: RSign® is een e-Signature- en digitaal transactiebeheerplatform voor veilige, juridisch bindende en gestroomlijnde documentwerkstromen. Publisher: RPost
1. Connectormogelijkheden
De RSign-connector® biedt toegang tot e-handtekening- en documentbeheerfuncties, zodat gebruikers RSign-werkstromen rechtstreeks kunnen integreren in hun Power Platform-oplossingen (Power Automate, Power Apps en Logic Apps).
Belangrijkste acties
De connector ondersteunt momenteel de volgende primaire bewerkingen:
-
AuthToken ophalen: Verifieert de gebruiker op basis van RSign-referenties® en haalt een benodigd token (
AuthToken) op dat is vereist voor alle volgende API-aanroepen. - Envelop verzenden met behulp van een sjabloon: Hiermee verzendt u een document voor e-handtekening met behulp van een vooraf geconfigureerde RSign-sjabloon®, waarbij sjabloonrollen worden toegewezen aan specifieke geadresseerden.
- Envelop verzenden met behulp van een regel: Hiermee wordt een document voor e-handtekening verzonden met behulp van een vooraf geconfigureerde RSign-regel®, zodat documenten kunnen worden opgegeven als Base64-gegevens in de aanvraagbody.
-
Sjabloongegevens ophalen: Hiermee worden details opgehaald over een specifieke RSign-sjabloon® of -regel, inclusief gedefinieerde documenten en rollen van geadresseerden (
RoleID). - Envelopstatus ophalen: Haalt de status van een e-handtekeningaanvraag op met behulp van de envelopcode.
- Envelopdocumenten ophalen: Hiermee downloadt u de documenten die zijn gekoppeld aan een envelopcode (oorspronkelijke en/of definitieve ondertekende documenten).
2. Verificatie-instelling
De RSign-connector® maakt gebruik van een aangepast verificatieschema waarvoor een geslaagde aanroep van de Get AuthToken actie is vereist voordat een andere actie wordt uitgevoerd.
Verificatieactie (Get AuthToken)
Voor deze actie zijn de volgende referenties vereist, die moeten worden verkregen via het RSign-platform®:
| Parameternaam | Typologie | Description | Zichtbaarheid |
|---|---|---|---|
ReferenceKey |
touw | De referentiesleutel die is gekoppeld aan uw RPost-account®. | Belangrijk |
EmailId |
touw | Het e-mailadres van uw RSign-account®. | Belangrijk |
Password |
wachtwoord | Het wachtwoord voor uw RSign-account®. | Belangrijk |
Het gebruik van de AuthToken
De Get AuthToken actie retourneert een AuthToken in de hoofdtekst van het antwoord. Dit token moet vervolgens worden doorgegeven in volgende API-aanroepen naar alle andere ondersteunde acties.
Opmerking: De AuthToken heeft een verlooptijd (AuthTokenExpires) en moet worden beheerd binnen de stroom- of toepassingslogica om ervoor te zorgen dat er een nieuw token wordt gebruikt wanneer de bestaande is verlopen.
3. Vereisten
Als u deze aangepaste RSign-connector® wilt gebruiken, moeten gebruikers voldoen aan de volgende vereisten:
- Geldige RSign-licentie®: Gebruikers moeten een actieve en geldige RSign-gebruikerslicentie® hebben.
-
API-toegang: Voor het RSign-account® dat is gekoppeld aan de opgegeven referenties, moet de API Access-functie zijn ingeschakeld en betaald. Deze functie is vereist voor het
ReferenceKeygenereren en gebruiken van de RSign-connector®.
Als u momenteel niet aan deze vereisten voldoet of als u niet zeker weet of uw huidige RSign-account® is ingesteld, neemt u contact op met uw RPost-vertegenwoordiger®.
4. Belangrijke opmerkingen voor integratie
Sjabloon- en regelgebruik
-
Sjablooncode/regelcode: Voor beide
Send Envelopeacties is eenTemplateCode(of regelcode) vereist waarmee de vooraf geconfigureerde document- en ondertekeningsvelden in RSign® worden geïdentificeerd. -
Roltoewijzing: Wanneer u een envelop verzendt, moet de
TemplateRoleRecipientMappingmatrix worden ingevuld. DeRoleIDvoor elke geadresseerde moet eerst worden opgehaald met behulp van deRetrieve Template Informationactie. Dit zorgt ervoor dat geadresseerden correct zijn toegewezen aan de handtekeningvelden die in de sjabloon zijn gedefinieerd.
Documentafhandeling
-
Envelop verzenden met behulp van een regel: Voor deze actie moet de documentinhoud worden doorgegeven als een base64-gecodeerde tekenreeks (
DocumentBase64Data). -
Envelopdocumenten ophalen: De documenten worden geretourneerd in de hoofdtekst van het antwoord als Base64-tekenreeksen (
ByteArray). De verbruikende stroom moet deze tekenreeks decoderen om het bestand op te slaan.
Foutafhandeling
Alle acties retourneren statusinformatie in de hoofdtekst van het antwoord, waaronder:
-
StatusCode(geheel getal) -
StatusMessage(tekenreeks) -
Message(tekenreeks)
Gebruikers moeten foutcontrole implementeren op basis van de StatusCode implementatie om te zorgen voor een geslaagde uitvoering van de bewerking.
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
|
Auth |
Retourneert een AuthToken dat moet worden gebruikt in alle andere ondersteunde RSign-acties. |
| Envelop verzenden met behulp van een regel |
Hiermee wordt een eSign-aanvraag verzonden naar geselecteerde geadresseerden met behulp van de aangegeven RSign-regel. |
| Envelop verzenden met behulp van een sjabloon |
Hiermee wordt een eSign-aanvraag verzonden naar geselecteerde geadresseerden met behulp van de aangegeven RSign-sjabloon. |
| Envelopdocumenten ophalen |
Hiermee haalt u het documentengedeelte van een envelop op op basis van de bijbehorende envelopcode. De oorspronkelijke documenten en/of de uiteindelijke ondertekende documenten worden opgehaald, afhankelijk van de envelopstatus. |
| Envelopstatus ophalen |
Haalt de status van een envelop op op basis van de bijbehorende envelopcode. U kunt een gedetailleerd of samengevat rapport selecteren. |
| Sjabloongegevens ophalen |
Haalt de informatie over een sjabloon of regel op basis van de bijbehorende code op. De geretourneerde informatie is de sjabloonnaam, documenten en rollen die zijn gedefinieerd. |
AuthToken ophalen
Retourneert een AuthToken dat moet worden gebruikt in alle andere ondersteunde RSign-acties.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ReferenceKey
|
ReferenceKey | True | string |
Unieke id van uw bedrijfsaccount. |
|
EmailId
|
EmailId | True | string |
E-mailadres van uw RSign-account. |
|
Wachtwoord
|
Password | True | password |
Wachtwoord van uw RSign-account. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Verificatiebericht
|
AuthMessage | string |
Antwoordstatusbericht. |
|
Verificatietoken
|
AuthToken | string |
Verificatietoken dat moet worden gebruikt in andere RSign-acties. |
|
Token vernieuwen
|
RefreshToken | string |
Token vernieuwen. |
|
Token vernieuwen verloopt
|
RefreshTokenExpires | string |
De datum waarop het huidige vernieuwingstoken verloopt. |
|
Verificatietoken verloopt
|
AuthTokenExpires | string |
De datum waarop het huidige verificatietoken verloopt. |
|
E-mail-id
|
EmailId | string |
E-mail van de geverifieerde gebruiker. |
|
API-id
|
ApiId | string |
API-id. |
Envelop verzenden met behulp van een regel
Hiermee wordt een eSign-aanvraag verzonden naar geselecteerde geadresseerden met behulp van de aangegeven RSign-regel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Verificatietoken
|
AuthToken | True | string |
AuthToken opgehaald uit de actie AuthToken ophalen. |
|
TemplateCode
|
TemplateCode | True | string |
Id van de regel die moet worden gebruikt. |
|
Naam
|
Name | True | string |
Documentnaam. Neem de extensie op (bijvoorbeeld: Agreement.docx). |
|
DocumentBase64Data
|
DocumentBase64Data | True | string |
Het document dat moet worden verzonden in de Base64-indeling. |
|
App-sleutel
|
AppKey | string |
Unieke id van een systeem met behulp van de connector. Vraag dit aan RPost® Support. |
|
|
RoleID
|
RoleID | True | string |
Rol-id voor de ontvanger. Opgehaald uit de actie Sjabloongegevens ophalen. |
|
RecipientEmail
|
RecipientEmail | True | string |
E-mailadres van de geadresseerde. |
|
RecipientName
|
RecipientName | True | string |
Naam van de geadresseerde. |
|
Mobiel
|
Mobile | string |
Mobiel nummer van de ontvanger. Als uw regel deze niet nodig heeft, laat u deze leeg. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Envelopcode
|
EnvelopeCode | string |
Id van de envelop. |
|
Bericht over transparantie gewijzigd
|
TransparencyChangedMessage | string |
Doorzichtigheid gewijzigd bericht. |
|
Api-bericht op basis van taal
|
LanguageBasedApiMessge | string |
Api-bericht op basis van taal. |
|
Adres-id vooraf doorvoeren
|
PrefillRecipientId | string |
Adres-id vooraf doorvoeren. |
|
Verzendende navigatiepagina posten
|
PostSendingNavigationPage | string |
Website waar de ontvanger naar wordt omgeleid zodra hij klaar is met het ondertekenen van de envelop. |
|
Is nieuwe gebruikersinterface voor ondertekenaar ingeschakeld
|
IsNewSignerUIEnabled | boolean |
Is nieuwe gebruikersinterface voor ondertekenaar ingeschakeld. |
|
Statuscode
|
StatusCode | integer |
Antwoordstatuscode. |
|
Statusbericht
|
StatusMessage | string |
Antwoordstatusbericht. |
|
Message
|
Message | string |
Beschrijving van antwoordstatus. |
|
Envelop-id
|
EnvelopeId | string |
Interne id van de gegenereerde envelop. |
|
Document-URL ondertekenen
|
SignDoumentUrl | string |
Algemene URL voor handtekening van de envelop. |
|
Adressenlijst
|
RecipientList | array of object |
Details van geadresseerden |
|
Naam ontvanger
|
RecipientList.RecipientName | string |
Naam van de geadresseerde. |
|
E-mailadres van geadresseerde
|
RecipientList.RecipientEmail | string |
E-mailadres van de geadresseerde. |
|
Bestelling
|
RecipientList.Order | integer |
Volgorde waarin de geadresseerde toegang nodig heeft om de envelop te voltooien. |
|
Typologie
|
RecipientList.Type | string |
Type ontvangergedeelte van de huidige envelop. Mogelijke waarden zijn: Ondertekenaar en Vooraf doorvoeren. |
|
Bezorgingsmodus
|
RecipientList.DeliveryMode | integer |
Geeft het kanaal aan waarmee de handtekeningaanvraag en toegangscode naar de ontvanger zijn verzonden. |
|
Kiescode
|
RecipientList.DialCode | string |
Kiescode van het land waar de handtekeningaanvraag en toegangscode zijn verzonden. |
|
Landcode
|
RecipientList.CountryCode | string |
Code van het land waar de handtekeningaanvraag en toegangscode zijn verzonden. |
|
Mobiel nummer
|
RecipientList.Mobile | string |
Mobiel nummer van de ontvanger. |
|
Mobiele modus
|
RecipientList.MobileMode | integer |
Geeft het mobiele kanaal aan waarmee de handtekeningaanvraag en toegangscode naar de ontvanger zijn verzonden. |
|
Url voor ondertekening
|
RecipientList.SigningUrl | string |
DE URL die door de ontvanger moet worden gebruikt om de envelop te openen en te ondertekenen. |
|
Vervolgkeuzelijst kiescode
|
DialCodeDropdownList | string |
Vervolgkeuzelijst kiescode. |
|
Bericht naar mobiel inschakelen
|
EnableMessageToMobile | string |
Schakel bericht in op mobiel. |
Envelop verzenden met behulp van een sjabloon
Hiermee wordt een eSign-aanvraag verzonden naar geselecteerde geadresseerden met behulp van de aangegeven RSign-sjabloon.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Verificatietoken
|
AuthToken | True | string |
AuthToken opgehaald uit de actie AuthToken ophalen. |
|
TemplateCode
|
TemplateCode | True | string |
Id van de sjabloon die moet worden gebruikt. |
|
App-sleutel
|
AppKey | string |
Unieke id van een systeem met behulp van de connector. Vraag dit aan RPost® Support. |
|
|
RoleID
|
RoleID | True | string |
Rol-id voor de ontvanger. Opgehaald uit de actie Sjabloongegevens ophalen. |
|
RecipientEmail
|
RecipientEmail | True | string |
E-mailadres van de geadresseerde. |
|
RecipientName
|
RecipientName | True | string |
Naam van de geadresseerde. |
|
Mobiel
|
Mobile | string |
Mobiel nummer van de ontvanger. Als uw sjabloon deze niet nodig heeft, laat u deze leeg. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Envelopcode
|
EnvelopeCode | string |
Id van de envelop. |
|
Bericht over transparantie gewijzigd
|
TransparencyChangedMessage | string |
Doorzichtigheid gewijzigd bericht. |
|
Api-bericht op basis van taal
|
LanguageBasedApiMessge | string |
Api-bericht op basis van taal. |
|
Adres-id vooraf doorvoeren
|
PrefillRecipientId | string |
Adres-id vooraf doorvoeren. |
|
Verzendende navigatiepagina posten
|
PostSendingNavigationPage | string |
Website waar de ontvanger naar wordt omgeleid zodra hij klaar is met het ondertekenen van de envelop. |
|
Is nieuwe gebruikersinterface voor ondertekenaar ingeschakeld
|
IsNewSignerUIEnabled | boolean |
Is nieuwe gebruikersinterface voor ondertekenaar ingeschakeld. |
|
Statuscode
|
StatusCode | integer |
Antwoordstatuscode. |
|
Statusbericht
|
StatusMessage | string |
Antwoordstatusbericht. |
|
Message
|
Message | string |
Beschrijving van antwoordstatus. |
|
Envelop-id
|
EnvelopeId | string |
Interne id van de gegenereerde envelop. |
|
Document-URL ondertekenen
|
SignDoumentUrl | string |
Algemene URL voor handtekening van de envelop. |
|
Adressenlijst
|
RecipientList | array of object |
Details van geadresseerden |
|
Naam ontvanger
|
RecipientList.RecipientName | string |
Naam van het geadresseerdegedeelte van de huidige envelop. |
|
E-mailadres van geadresseerde
|
RecipientList.RecipientEmail | string |
E-mailadres van het geadresseerdegedeelte van de huidige envelop. |
|
Bestelling
|
RecipientList.Order | integer |
Volgorde waarin de geadresseerde toegang nodig heeft om de envelop te voltooien. |
|
Typologie
|
RecipientList.Type | string |
Type ontvangergedeelte van de huidige envelop. Mogelijke waarden zijn: Ondertekenaar en Vooraf doorvoeren. |
|
Bezorgingsmodus
|
RecipientList.DeliveryMode | integer |
Geeft het kanaal aan waarmee de handtekeningaanvraag en toegangscode naar de ontvanger zijn verzonden. |
|
Kiescode
|
RecipientList.DialCode | string |
Kiescode van het land waar de handtekeningaanvraag en toegangscode zijn verzonden. |
|
Landcode
|
RecipientList.CountryCode | string |
Code van het land waar de handtekeningaanvraag en toegangscode zijn verzonden. |
|
Mobiel nummer
|
RecipientList.Mobile | string |
Mobiel nummer van de ontvanger. |
|
Mobiele modus
|
RecipientList.MobileMode | integer |
Geeft het mobiele kanaal aan waarmee de handtekeningaanvraag en toegangscode naar de ontvanger zijn verzonden. |
|
Ondertekenings-URL
|
RecipientList.SigningUrl | string |
DE URL die door de ontvanger moet worden gebruikt om de envelop te openen en te ondertekenen. |
|
Vervolgkeuzelijst kiescode
|
DialCodeDropdownList | string |
Vervolgkeuzelijst kiescode. |
|
Bericht naar mobiel inschakelen
|
EnableMessageToMobile | string |
Schakel bericht in op mobiel. |
Envelopdocumenten ophalen
Hiermee haalt u het documentengedeelte van een envelop op op basis van de bijbehorende envelopcode. De oorspronkelijke documenten en/of de uiteindelijke ondertekende documenten worden opgehaald, afhankelijk van de envelopstatus.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelopcode
|
EnvelopeCode | True | string |
Code van de envelop die moet worden opgehaald. |
|
Verificatietoken
|
AuthToken | True | string |
AuthToken opgehaald uit de actie AuthToken ophalen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Toestand
|
Status | boolean |
Vlag voor geslaagde status. |
|
Statuscode
|
StatusCode | integer |
Antwoordstatuscode. |
|
Message
|
Message | string |
Beschrijving van antwoordstatus. |
|
Statusbericht
|
StatusMessage | string |
Antwoordstatusbericht. |
|
Envelopcode
|
Data.EnvelopeCode | string |
Envelopcode doorgegeven als parameter. |
|
Lijst met documenten
|
Data.DocumentList | array of object |
Lijst met documenten. |
|
Documenttype
|
Data.DocumentList.DocumentType | string |
Type bijlage. |
|
Bestandsnaam
|
Data.DocumentList.FileName | string |
Naam van het bestand. |
|
Description
|
Data.DocumentList.Description | string |
Beschrijving van het document. |
|
Bytematrix
|
Data.DocumentList.ByteArray | string |
Bestand in Base64-indeling. |
|
Aanvullende info
|
Data.DocumentList.AdditionalInfo | string |
Aanvullende informatie. |
|
Beschrijving van bijlage
|
Data.DocumentList.AttachmentDescription | string |
Informatieve beschrijving van de bestandsinhoud. |
|
Lees me
|
Data.ReadMe | string |
Tekstbestand in Base64-indeling die de naam van het ondertekende document en het oorspronkelijke bestand aangeeft. |
|
Gecombineerde zip
|
Data.CombinedZip | string |
Zip-bestand met alle documenten van de envelop. |
|
Totaal aantal
|
TotalCount | integer |
Totaal aantal. |
|
Bestaan bijlagen uploads
|
IsAttachmentUploadsExist | string |
Zijn er bijlagen geüpload. |
Envelopstatus ophalen
Haalt de status van een envelop op op basis van de bijbehorende envelopcode. U kunt een gedetailleerd of samengevat rapport selecteren.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Verificatietoken
|
AuthToken | True | string |
AuthToken opgehaald uit de actie AuthToken ophalen. |
|
Envelopcode
|
EnvelopeCode | True | string |
Envelopcode. |
|
DetailOrSummary
|
DetailOrSummary | True | string |
Selecteer het gewenste type rapport. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Toestand
|
Status | boolean |
Status van de aanvraag. |
|
Statuscode
|
StatusCode | integer |
Antwoordstatuscode. |
|
Message
|
Message | string |
Beschrijving van antwoordstatus. |
|
Statusbericht
|
StatusMessage | string |
Antwoordstatusbericht. |
|
Envelopgegevenslijst
|
Data | array of object | |
|
Envelopcode
|
Data.EnvelopeCode | string |
Id van de envelop. |
|
Envelop-id
|
Data.EnvelopeID | string |
Interne id van de envelop. |
|
Onderwerp
|
Data.Subject | string |
E-mailonderwerp van de envelop. |
|
Envelopstatus
|
Data.Status | string |
Status van de aangevraagde envelop. |
|
IsEnvelopeComplete
|
Data.IsEnvelopeComplete | boolean |
Geeft aan of de envelop is voltooid. |
|
Verzonden datum
|
Data.SentDate | string |
Datum waarop de envelop is verzonden. |
|
LaatsteWijzigingsDatum
|
Data.LastModifiedDate | string |
Datum laatst gewijzigd. |
|
SenderName
|
Data.SenderName | string |
Naam van de afzender. |
|
SenderEmail
|
Data.SenderEmail | string |
E-mail van de afzender. |
|
Details van geadresseerde
|
Data.RecipientDetails | array of object | |
|
Id ontvanger
|
Data.RecipientDetails.RecipientID | string |
Id van het geadresseerdegedeelte van de huidige envelop. |
|
Type-id van geadresseerde
|
Data.RecipientDetails.RecipientTypeID | string |
Type-id van het geadresseerdegedeelte van de huidige envelop. |
|
Type ontvanger
|
Data.RecipientDetails.RecipientType | string |
Type ontvangergedeelte van de huidige envelop. Mogelijke waarden zijn: Ondertekenaar en Vooraf doorvoeren. |
|
Naam ontvanger
|
Data.RecipientDetails.RecipientName | string |
Naam van de geadresseerde. |
|
E-mailen
|
Data.RecipientDetails.Email | string |
E-mailadres van de geadresseerde. |
|
Bestelling
|
Data.RecipientDetails.Order | integer |
Volgorde waarin de geadresseerde toegang nodig heeft om de envelop te voltooien. |
|
Status-id
|
Data.RecipientDetails.StatusId | string |
Status-id. |
|
Ondertekeningsstatus
|
Data.RecipientDetails.SigningStatus | string |
Status van de handtekening voor de ontvanger van de envelop. |
|
Datum laatst gewijzigd
|
Data.RecipientDetails.LastModifiedDate | string |
Datum laatst gewijzigd. |
|
Referentiecode
|
Data.ReferenceCode | string |
Referentiecodegedeelte van de huidige envelop. |
|
Referentie-e-mail
|
Data.ReferenceEmail | string |
Referentie-e-mailgedeelte van de huidige envelop. |
|
TotalCount
|
TotalCount | integer |
Totale hoeveelheid enveloppen die voldoen aan de aangevraagde criteria. |
|
IsAttachmentUploadsExist
|
IsAttachmentUploadsExist | string |
Zijn er bijlagen geüpload. |
Sjabloongegevens ophalen
Haalt de informatie over een sjabloon of regel op basis van de bijbehorende code op. De geretourneerde informatie is de sjabloonnaam, documenten en rollen die zijn gedefinieerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sjablooncode
|
TemplateCode | True | string |
Code van de sjabloon die moet worden opgehaald. |
|
Verificatietoken
|
AuthToken | True | string |
AuthToken opgehaald uit de actie AuthToken ophalen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Statuscode
|
StatusCode | integer |
Antwoordstatuscode. |
|
Statusbericht
|
StatusMessage | string |
Antwoordstatusbericht. |
|
Message
|
Message | string |
Beschrijving van antwoordstatus. |
|
Sjabloon-id
|
TemplateId | string |
Sjabloon-id. |
|
Sjabloon-id
|
TemplateBasicInfo.TemplateId | string |
Sjabloon-id. |
|
Sjablooncode
|
TemplateBasicInfo.TemplateCode | integer |
Sjablooncode die moet worden gebruikt in andere acties. |
|
E-mailadres van gebruiker
|
TemplateBasicInfo.UserEmail | string |
E-mail van de eigenaar van de gebruiker van de sjabloon. |
|
Sjabloonnaam
|
TemplateBasicInfo.TemplateName | string |
Naam van de sjabloon. |
|
Beschrijving van sjabloon
|
TemplateBasicInfo.TemplateDescription | string |
Beschrijving van de sjabloon. |
|
Is statisch
|
TemplateBasicInfo.IsStatic | string |
Hiermee wordt aangegeven of de sjabloon kan worden gewijzigd of niet. |
|
Vervaldatum
|
TemplateBasicInfo.ExpiryDate | string |
De datum waarop de sjabloon verloopt. |
|
Aanmaakdatum
|
TemplateBasicInfo.CreatedDate | string |
De datum waarop de sjabloon is gemaakt. |
|
Datum laatst gewijzigd
|
TemplateBasicInfo.LastModifiedDate | string |
De datum waarop de sjabloon voor de laatste keer is gewijzigd. |
|
Onderwerp
|
TemplateBasicInfo.Subject | string |
Onderwerp van e-mailsjabloon. |
|
Body
|
TemplateBasicInfo.Body | string |
Hoofdtekst van e-mailsjabloon. HTML-gecodeerd. |
|
Typenaam
|
TemplateBasicInfo.TypeName | string |
Type sjabloon (mogelijke waarden: Sjabloon, regel). |
|
Lijst met documenten
|
TemplateBasicInfo.DocumentList | array of object |
Lijst met documenten. |
|
Document-id
|
TemplateBasicInfo.DocumentList.DocumentId | string |
Id van het documentonderdeel van de sjabloon. |
|
Documentnaam
|
TemplateBasicInfo.DocumentList.DocumentName | string |
Naam van het documentonderdeel van de sjabloon. |
|
Bestelling
|
TemplateBasicInfo.DocumentList.Order | integer |
Volgorde van het documentonderdeel van de sjabloon in de documentenlijst. |
|
Details van documentinhoud
|
TemplateBasicInfo.DocumentList.documentContentDetails | array of object |
Details van documentinhoud. |
|
ID van controlelement
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlID | string |
Interne id van het besturingselement dat in het document wordt gebruikt. |
|
Besturingsnaam
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlName | string |
Naam van het besturingselement dat in het document wordt gebruikt. |
|
Html-id van besturingselement
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID | string |
HTML-id van het besturingselement dat in het document wordt gebruikt. |
|
Groepsnaam
|
TemplateBasicInfo.DocumentList.documentContentDetails.GroupName | string |
Naam van de groep die het besturingselement bevat. |
|
Etiket
|
TemplateBasicInfo.DocumentList.documentContentDetails.Label | string |
De naam van het besturingselement dat in het document moet worden weergegeven. |
|
Pagina nee
|
TemplateBasicInfo.DocumentList.documentContentDetails.PageNo | integer |
Pagina in het document waarin het besturingselement zich bevindt. |
|
Verplicht
|
TemplateBasicInfo.DocumentList.documentContentDetails.Required | boolean |
Of het besturingselement wel of niet vereist is. |
|
Waarde van besturingselement
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue | string |
Vooraf ingevulde waarde van het besturingselement. |
|
Rol-id
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleId | string |
Id van de rol die het besturingselement moet vullen. |
|
Rolnaam
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleName | string |
Naam van de rol die het besturingselement moet vullen. |
|
Besturingselementopties selecteren
|
TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions | array of string |
Selecteer Opties voor besturingselementen. |
|
Lijst met sjabloonrollen
|
TemplateBasicInfo.TemplateRoleList | array of object |
Lijst met geadresseerden. |
|
Rol-id
|
TemplateBasicInfo.TemplateRoleList.RoleID | string |
Id van het rolonderdeel van deze sjabloon. |
|
Rolnaam
|
TemplateBasicInfo.TemplateRoleList.RoleName | string |
Naam van het rolonderdeel van deze sjabloon. |
|
Bestelling
|
TemplateBasicInfo.TemplateRoleList.Order | integer |
Volgorde waarin de rol (ontvanger) de sjabloon moet voltooien. |
|
E-mailadres van geadresseerde
|
TemplateBasicInfo.TemplateRoleList.RecipientEmail | string |
Vooraf ingevulde e-mail van het geadresseerdegedeelte van deze sjabloon. |
|
Naam ontvanger
|
TemplateBasicInfo.TemplateRoleList.RecipientName | string |
Vooraf ingevulde naam van het geadresseerdegedeelte van deze sjabloon. |
|
Type-id van geadresseerde
|
TemplateBasicInfo.TemplateRoleList.RecipientTypeID | string |
Interne id van het type geadresseerde. |
|
Id ontvanger
|
TemplateBasicInfo.TemplateRoleList.RecipientID | string |
Id van het geadresseerdegedeelte van deze sjabloon. |
|
Type ontvanger
|
TemplateBasicInfo.TemplateRoleList.RecipientType | string |
Type geadresseerde. |
|
Type CC-ondertekenaar
|
TemplateBasicInfo.TemplateRoleList.CcSignerType | string |
Type CC-geadresseerde. |
|
Cultuurinformatie
|
TemplateBasicInfo.TemplateRoleList.CultureInfo | string |
Het is de servicetaal van de gebruiker op het moment van het maken van de sjabloon/regel. |
|
Bezorgingsmodus
|
TemplateBasicInfo.TemplateRoleList.DeliveryMode | integer |
Geeft het kanaal aan waarmee de handtekeningaanvraag en toegangscode naar de ontvanger zijn verzonden. |
|
Kiescode
|
TemplateBasicInfo.TemplateRoleList.DialCode | string |
Kiescode van het land waar de handtekeningaanvraag en toegangscode zijn verzonden. |
|
Landcode
|
TemplateBasicInfo.TemplateRoleList.CountryCode | string |
Code van het land waar de handtekeningaanvraag en toegangscode zijn verzonden. |
|
Mobiel nummer
|
TemplateBasicInfo.TemplateRoleList.Mobile | string |
Mobiel nummer van de ontvanger. |
|
Mobiele modus
|
TemplateBasicInfo.TemplateRoleList.MobileMode | integer |
Geeft het mobiele kanaal aan waarmee de handtekeningaanvraag en toegangscode naar de ontvanger zijn verzonden. |
|
E-mailadres
|
TemplateBasicInfo.TemplateRoleList.EmailAddress | string |
E-mailadres van de geadresseerde. |
|
Bericht naar mobiel inschakelen
|
TemplateBasicInfo.EnableMessageToMobile | boolean |
Schakel bericht in op mobiel. |
|
Vervaldatum van statische koppeling
|
TemplateBasicInfo.StaticLinkExpiryDate | string |
Vervaldatum van statische koppeling. |
|
Sjabloonlijst
|
TemplateList | string |
Sjabloonlijst. |