WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-08 10:47:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
fd65067ea487d92fefaf61cbbe01ff976830d7a7
OpenSign/assets/js/4227e71a.22562dc8.js
T

1 line
26 KiB
JavaScript
Raw Blame History

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5342],{64875(e,n,t){t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>b,default:()=>T,frontMatter:()=>y,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/v1.1/get-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-template","permalink":"/docs/API-docs/v1.1/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztG8ty2zjyV7C47ERF62XZTnQa70wq45pUkoqdTe3aLg1EtkTEIMABQEsal6rmsH+wp73up82XbDVAUqRefsTjeKuUgyMC3UC/0Gg00DfUsrGh/XN6BkkqmAVDLwMagQk1Ty1XkvbpWQzkDVhSgJDjDyeECaEmhsxURqwiGqzmcA0kAsu4MIQNVWYJIyaFkI94SGyO3CyHMcSAvgbCDBmKDFLNpTVkpDQJNTDL5ZhEKswSwOYJtzFJNUQw4hIiYqzOQptpMM0LeSEbjY9gUiUNGKJG5JSPJWjymUdjsKbfaCBMp0kaDcPHkiEetv3yyy8X8uZCEnJB7SyFC9onF7QEuaCB70vZ2PV18u8pfux3j/LPGX4edl/mnxMH2unlnzF+djsXcp5PeCG7jhLLknQLFdj9qBTkX8qp1WCbmxTbNPyacQ0RNlqdQVB0SJbU6cGOeZWXfeSFS245E2YzOwXEM+JoQdIKUz1kChLGxWaOXPczYqdKD/aESijtu4aChVeVrpGS1vDfPMHdsjnmEQwsTO0AV9uAGQuamytHyYgJAytyOkA5IQmbxeQJfDZSqpDzVEI6RCF9UUNyxq3YIikEsQjyjMS1TNNTyewIZRaqJGVytlliOcAzkledoqeS1kuUVsTsFuPC3mckpwo52BHBiGXC+r52b69zsNdtd3s1WemE5QBJshdFe7PZ7OvknHA58HQgUgU+YdP1HRpYpKSYlZooezBm4HJcoq3X0yvUE2p2qKabVZUDPJW2FkqpT7xVk5slUVPlkreNucw7Uq2ueQRkCUDDOBNMwzTVYAxXckUFT7GcOm3nfWIIr7YqqoB4RutqiSTsvGYiAzfQOZq2c+UoLVj8VjYGfUEvF+YMAkIL0S24l3ewBxS/YEMQq13316VgM5XlJnQN2vKQiTqrPGI2t5tcbvlS9ywVMm0HlU42Xer0ffNVw3BHiEirNFITucXZ5hDPyDCWSNqus4eYTG3dP2TBrkrbHZM0i7giw8xatUXiVahnJPU1ZP3Jks/hHnuJrSrHn/sSNt4SdLjuZ6SOnJ5VZtx5T2bJEPSWk4zr385Op11j56DOzmH7Abtybdqv35TbZeNiN34tLWiyMhHGXJlgK0s6gpAnTKSChd5Wu19hbw/Ynt2pMwSxLd/gum/TVbuqq8XnOtM7aN9JWdVpH6grHGIQqswr5+BWB7tQ47MLpJaych80jLgQZOLTcqi8zuNFxN1XdXUeHtTUeVBfexvVuUlnWwJlRPFsXuSHZlh0VeTsxizaVze/uuy6j3Gm6xzt19zRyyc809Vl0u61OgetrYe6VhS1Hnqoc6ZHyEpi8rGC+M5Rt7ZN7W/zFc8kiK8q4Jbw/TGC9JXV3/szwrcliz7qfIPw7WuVsRKlPZr4yUpy9usjtKVt8lXNrb7qVuV9cPB18q5SsyS0C8r//rf3Hyftn9+M1fHx8fG700/x60/j4+PjBL+bzeZKYEcDqlLQ7kB4EtE+HYMtLp9oQFOmWQIWNN5/3TgyaJ8W91QDHtGAcrz/SpmN6fKl2MmPuKUV0MTGzBIJEBm8DhsCGYENY8AxCsZp37FNjZ0JnMnwJBVICExToSKgfa96asIYEkb7N05RCGk1l2Ma5A7Tt8gxnc8vg1JIBhG67Tb+VyfVZGEIxowyQUp50ICGSlqQFuFZmgoeuo7WF4NIN6tUqOEXCC0KTuMwlvspfTPKdzu9vgWmzHHdp9POT0OZmO6HMZ0H1CWZ1w2xQDDuRylyxJLK3oJUKsiBzpe0eCfMKsY8oCnIgVuVpoLPtGYztBcLiVkdd14Z+JzibaezC7QOt6rp5TygBmQEeuDtcBtlKgWJCUe6QHKXP9uxEAL09wWyYEPTDFWSi5GPZgMlB+XdZ5WJoVICmKyO5ix1HtAE9BgGIVrDCA0I7oY2UiIC/VS2dbtEPT0uG0nnC2tcOIOcYCSd32ansbWp6bdaBXJmQBeSVhNZ43ub3blbcFVQFbgcM9zJ6jZIU6vbSA9B3U1gXxSQITiy7mB6XxQMAb7PGwpZpLGSt0zTOzjsdvZfHnUQPj82PJx/33s/S8pDfUcvG1fR/XG5il62lOideUCn98Tp9nrzgM7uiXWEU03uibT/ch7Q+J5IvUO0Y7/B3y7zTaZ0R5k7R3tffO9SnZuR9pT/dm+tdVEsG067ax1cOdhGnzdf61b8OxUzyE17kL+eoduhF1De/5/I97ruTteQgbEHChSdCkTHdvvC67a7+3ud9l776Kxz2O+96h8cNtvt9j9pQKeJWCjWHfoq+3f5naXRk8wDkg0FnKnsbuxriLiG0A4yvdZnbTMrnM69ehokKvLb3dIa2LLjscyqgYaEy1s1VaBYnsCZ+kFhq4Uf2cyss+N6qIc4GICGORaJ2MwQbkhmIHIdTISZ215gmnI9IyhIjGRnKtPle6tb1seBkyTyMlAyhAGXA7gGvdZnlVhtdKE+A7TObdT5+IfKSMgkKe4J8wVCJjEPY9cDyRAiMoSR0kBwFeB7MauI3yVX/NBz3TxWX9ohZJ6LJUrmHNu4kAExscpERFiaAtNNVCxB1Z03Gj/CMBuTTyeNxuV3RRDC0rS5HPK1IgRMo9GLukXgJO5s23zgrlZnZkpCtad0xCUO/p2AkSVZmoImodIS9Asy0irJGXw+zLXbm7bfOnuz/0v29tub4oQ6d595ZGP0C57yb0Jrr70pPKnT+hPwcWy/MbEv248RFq31HcUJ/9Yge2vEtIDEg2ceHZkN0VE1FvL/Fltv4cSxrb5Jl5FKGaGsiWIqMc48oL11CYtTlYCN0aFPQFoy0UqOA5IKYAaI1TPCxoxLgsPpvzxeJgO0vk1096OsKjUuBZcwKHQ56LXbg04phN6qEM4qmQsyUpmMnpbVdfNvZ6g3OCwZOlhl6ES69xnu9fiZugL5tPxUp7d++lUL5h7I9dMas9V2z6SBMNPczlz2cLrHUr7n+/vnl5iYQ0tRedrRpRttTPu0TAu0biqpxjnF8fR1kYx04WmZSTBMRkM1XfVZLOWt604Tj8fLOGt93BZ4yPbui2IsG3M5vg3vciGqU1Sn11hNYIugLOU/A0ZluT6qUHk2NgbmUjFz/B4ph5xr6X0KEg9JTsdu8pVtDUSofIiMjr3RKFD++Nd/S6xGowyEnTW6CoP3mSapmoDGNCqTERkJmPKh8NUQkLi+sh7CAEsEGCNmhEsLY+0SiXzMLRMkfyxIQpayIRccjRjBlA/CK+vANMnnGPAuAbv+qoEwEsE1CLR9gmeKpF4oQSZKX42wMiMgjAwzwyUYQ0DGTIYIWGgiIEoTDKPx6j/V3ACWVCDV3NOmpNUstCRhko0Bxw5IVVgRCI7mSrQaZsYSo0TmSCbo3pX2xw3HkEuLOyG+xky39nszHlE0xGg210DGGY/ABCRUERCf6UUWJIb4xpIUaeEhuOx6JoUKr5wCR5kQJFXoQjgTGAJUaUR0q5k0uG/nJ5xcB6XAUq0wOV7WkXwygBp+y+WVLxzZI+elXX2GoeEWFpHEZDJZMf0XdZw33P6UDclHSJXhVunZAnvMbZwN3XKpDlJ++JHegARnP5XFsBgjUqFZE8yo0LRiEGnrFCxaiGkdfzhxXvcF+eP3f5O3wLQksZp4aw0zDWJGxsVUKDmveS+20mm6+hyW2RglHnrjwwsOMLaQ4OeY2T9+/48h72BCuMyXFLLSaHzIhoKHixKgRqNPfnApiTKvb/xdCp7xhkBMzNCUrjkjjKQeW3B51STHcoZxnvalQWgM2O7wamygXCqFREOGJ2ElHca6oiQbQ2JAXIPBsXDzGwKBiFu06FirbOxnqxKTM5e/b/hcvG/ok+MoImn92QMKvEKOP8DaGGaE+ZOsbS6/lPA9WZoqjVRwT/xIYTICFQAyShVWT/VJpNnILsYPFobui6qUXNPkRchKcQT5MKVK/ErMOS5bm+6KbcmR1/2thhG4tIJje6GXlOfmdF6YJUFr/Rqz9sGvtCx00USelsYdZe2dhwWdmPejU9DXPCzS9htWdMsBt2hABQ8hj8TzHer4zYe35Hq/2aZBZXu8w+JuvT354fW709dIDDpSL7BOs91su4SBMjZhsjJTtQRveWO7WQRSu3K9XbnerlxvV663K9d7mJB25Xq7cr1dud7Wp527cr1duR55Nq/Md+V6u3K9XbnerlxvV663K9fblevtyvUuduV6D9PUrlxvV663K9fblevtyvV25XrfplwvfwWCDruVCsbdG5z8qbZ/P3NePiSjAe1Xi/UuAxorYxHk5gZveT9pMZ9j86+Ze5t8fhnQa6Y5Phh3j2wibvB3VBbebbxS++5jLo0X5O51f2uZKd65SHzk4iwTX5YH9ApmS8WHc6wJyx+7ILUe4jgMIbUV3JVXU7WnR29en1H3+DyuP7K5co9s8h84+lq66q9vPAH4F58CrUW4ufEPeObzEt53bcTIGSygUUiX8/n8f3w/8Mk=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"}}');var r=t(74848),i=t(28453),l=t(57742),a=t.n(l),o=t(78178),p=t.n(o),d=t(19624),c=t.n(d),m=t(96226),x=t.n(m),u=(t(77675),t(19365),t(51107)),h=t(21312);const y={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztG8ty2zjyV7C47ERF62XZTnQa70wq45pUkoqdTe3aLg1EtkTEIMABQEsal6rmsH+wp73up82XbDVAUqRefsTjeKuUgyMC3UC/0Gg00DfUsrGh/XN6BkkqmAVDLwMagQk1Ty1XkvbpWQzkDVhSgJDjDyeECaEmhsxURqwiGqzmcA0kAsu4MIQNVWYJIyaFkI94SGyO3CyHMcSAvgbCDBmKDFLNpTVkpDQJNTDL5ZhEKswSwOYJtzFJNUQw4hIiYqzOQptpMM0LeSEbjY9gUiUNGKJG5JSPJWjymUdjsKbfaCBMp0kaDcPHkiEetv3yyy8X8uZCEnJB7SyFC9onF7QEuaCB70vZ2PV18u8pfux3j/LPGX4edl/mnxMH2unlnzF+djsXcp5PeCG7jhLLknQLFdj9qBTkX8qp1WCbmxTbNPyacQ0RNlqdQVB0SJbU6cGOeZWXfeSFS245E2YzOwXEM+JoQdIKUz1kChLGxWaOXPczYqdKD/aESijtu4aChVeVrpGS1vDfPMHdsjnmEQwsTO0AV9uAGQuamytHyYgJAytyOkA5IQmbxeQJfDZSqpDzVEI6RCF9UUNyxq3YIikEsQjyjMS1TNNTyewIZRaqJGVytlliOcAzkledoqeS1kuUVsTsFuPC3mckpwo52BHBiGXC+r52b69zsNdtd3s1WemE5QBJshdFe7PZ7OvknHA58HQgUgU+YdP1HRpYpKSYlZooezBm4HJcoq3X0yvUE2p2qKabVZUDPJW2FkqpT7xVk5slUVPlkreNucw7Uq2ueQRkCUDDOBNMwzTVYAxXckUFT7GcOm3nfWIIr7YqqoB4RutqiSTsvGYiAzfQOZq2c+UoLVj8VjYGfUEvF+YMAkIL0S24l3ewBxS/YEMQq13316VgM5XlJnQN2vKQiTqrPGI2t5tcbvlS9ywVMm0HlU42Xer0ffNVw3BHiEirNFITucXZ5hDPyDCWSNqus4eYTG3dP2TBrkrbHZM0i7giw8xatUXiVahnJPU1ZP3Jks/hHnuJrSrHn/sSNt4SdLjuZ6SOnJ5VZtx5T2bJEPSWk4zr385Op11j56DOzmH7Abtybdqv35TbZeNiN34tLWiyMhHGXJlgK0s6gpAnTKSChd5Wu19hbw/Ynt2pMwSxLd/gum/TVbuqq8XnOtM7aN9JWdVpH6grHGIQqswr5+BWB7tQ47MLpJaych80jLgQZOLTcqi8zuNFxN1XdXUeHtTUeVBfexvVuUlnWwJlRPFsXuSHZlh0VeTsxizaVze/uuy6j3Gm6xzt19zRyyc809Vl0u61OgetrYe6VhS1Hnqoc6ZHyEpi8rGC+M5Rt7ZN7W/zFc8kiK8q4Jbw/TGC9JXV3/szwrcliz7qfIPw7WuVsRKlPZr4yUpy9usjtKVt8lXNrb7qVuV9cPB18q5SsyS0C8r//rf3Hyftn9+M1fHx8fG700/x60/j4+PjBL+bzeZKYEcDqlLQ7kB4EtE+HYMtLp9oQFOmWQIWNN5/3TgyaJ8W91QDHtGAcrz/SpmN6fKl2MmPuKUV0MTGzBIJEBm8DhsCGYENY8AxCsZp37FNjZ0JnMnwJBVICExToSKgfa96asIYEkb7N05RCGk1l2Ma5A7Tt8gxnc8vg1JIBhG67Tb+VyfVZGEIxowyQUp50ICGSlqQFuFZmgoeuo7WF4NIN6tUqOEXCC0KTuMwlvspfTPKdzu9vgWmzHHdp9POT0OZmO6HMZ0H1CWZ1w2xQDDuRylyxJLK3oJUKsiBzpe0eCfMKsY8oCnIgVuVpoLPtGYztBcLiVkdd14Z+JzibaezC7QOt6rp5TygBmQEeuDtcBtlKgWJCUe6QHKXP9uxEAL09wWyYEPTDFWSi5GPZgMlB+XdZ5WJoVICmKyO5ix1HtAE9BgGIVrDCA0I7oY2UiIC/VS2dbtEPT0uG0nnC2tcOIOcYCSd32ansbWp6bdaBXJmQBeSVhNZ43ub3blbcFVQFbgcM9zJ6jZIU6vbSA9B3U1gXxSQITiy7mB6XxQMAb7PGwpZpLGSt0zTOzjsdvZfHnUQPj82PJx/33s/S8pDfUcvG1fR/XG5il62lOideUCn98Tp9nrzgM7uiXWEU03uibT/ch7Q+J5IvUO0Y7/B3y7zTaZ0R5k7R3tffO9SnZuR9pT/dm+tdVEsG067ax1cOdhGnzdf61b8OxUzyE17kL+eoduhF1De/5/I97ruTteQgbEHChSdCkTHdvvC67a7+3ud9l776Kxz2O+96h8cNtvt9j9pQKeJWCjWHfoq+3f5naXRk8wDkg0FnKnsbuxriLiG0A4yvdZnbTMrnM69ehokKvLb3dIa2LLjscyqgYaEy1s1VaBYnsCZ+kFhq4Uf2cyss+N6qIc4GICGORaJ2MwQbkhmIHIdTISZ215gmnI9IyhIjGRnKtPle6tb1seBkyTyMlAyhAGXA7gGvdZnlVhtdKE+A7TObdT5+IfKSMgkKe4J8wVCJjEPY9cDyRAiMoSR0kBwFeB7MauI3yVX/NBz3TxWX9ohZJ6LJUrmHNu4kAExscpERFiaAtNNVCxB1Z03Gj/CMBuTTyeNxuV3RRDC0rS5HPK1IgRMo9GLukXgJO5s23zgrlZnZkpCtad0xCUO/p2AkSVZmoImodIS9Asy0irJGXw+zLXbm7bfOnuz/0v29tub4oQ6d595ZGP0C57yb0Jrr70pPKnT+hPwcWy/MbEv248RFq31HcUJ/9Yge2vEtIDEg2ceHZkN0VE1FvL/Fltv4cSxrb5Jl5FKGaGsiWIqMc48oL11CYtTlYCN0aFPQFoy0UqOA5IKYAaI1TPCxoxLgsPpvzxeJgO0vk1096OsKjUuBZcwKHQ56LXbg04phN6qEM4qmQsyUpmMnpbVdfNvZ6g3OCwZOlhl6ES69xnu9fiZugL5tPxUp7d++lUL5h7I9dMas9V2z6SBMNPczlz2cLrHUr7n+/vnl5iYQ0tRedrRpRttTPu0TAu0biqpxjnF8fR1kYx04WmZSTBMRkM1XfVZLOWt604Tj8fLOGt93BZ4yPbui2IsG3M5vg3vciGqU1Sn11hNYIugLOU/A0ZluT6qUHk2NgbmUjFz/B4ph5xr6X0KEg9JTsdu8pVtDUSofIiMjr3RKFD++Nd/S6xGowyEnTW6CoP3mSapmoDGNCqTERkJmPKh8NUQkLi+sh7CAEsEGCNmhEsLY+0SiXzMLRMkfyxIQpayIRccjRjBlA/CK+vANMnnGPAuAbv+qoEwEsE1CLR9gmeKpF4oQSZKX42wMiMgjAwzwyUYQ0DGTIYIWGgiIEoTDKPx6j/V3ACWVCDV3NOmpNUstCRhko0Bxw5IVVgRCI7mSrQaZsYSo0TmSCbo3pX2xw3HkEuLOyG+xky39nszHlE0xGg210DGGY/ABCRUERCf6UUWJIb4xpIUaeEhuOx6JoUKr5wCR5kQJFXoQjgTGAJUaUR0q5k0uG/nJ5xcB6XAUq0wOV7WkXwygBp+y+WVLxzZI+elXX2GoeEWFpHEZDJZMf0XdZw33P6UDclHSJXhVunZAnvMbZwN3XKpDlJ++JHegARnP5XFsBgjUqFZE8yo0LRiEGnrFCxaiGkdfzhxXvcF+eP3f5O3wLQksZp4aw0zDWJGxsVUKDmveS+20mm6+hyW2RglHnrjwwsOMLaQ4OeY2T9+/48h72BCuMyXFLLSaHzIhoKHixKgRqNPfnApiTKvb/xdCp7xhkBMzNCUrjkjjKQeW3B51STHcoZxnvalQWgM2O7wamygXCqFREOGJ2ElHca6oiQbQ2JAXIPBsXDzGwKBiFu06FirbOxnqxKTM5e/b/hcvG/ok+MoImn92QMKvEKOP8DaGGaE+ZOsbS6/lPA9WZoqjVRwT/xIYTICFQAyShVWT/VJpNnILsYPFobui6qUXNPkRchKcQT5MKVK/ErMOS5bm+6KbcmR1/2thhG4tIJje6GXlOfmdF6YJUFr/Rqz9sGvtCx00USelsYdZe2dhwWdmPejU9DXPCzS9htWdMsBt2hABQ8hj8TzHer4zYe35Hq/2aZBZXu8w+JuvT354fW709dIDDpSL7BOs91su4SBMjZhsjJTtQRveWO7WQRSu3K9XbnerlxvV663K9d7mJB25Xq7cr1dud7Wp527cr1duR55Nq/Md+V6u3K9XbnerlxvV663K9fblevtyvUuduV6D9PUrlxvV663K9fblevtyvV25XrfplwvfwWCDruVCsbdG5z8qbZ/P3NePiSjAe1Xi/UuAxorYxHk5gZveT9pMZ9j86+Ze5t8fhnQa6Y5Phh3j2wibvB3VBbebbxS++5jLo0X5O51f2uZKd65SHzk4iwTX5YH9ApmS8WHc6wJyx+7ILUe4jgMIbUV3JVXU7WnR29en1H3+DyuP7K5co9s8h84+lq66q9vPAH4F58CrUW4ufEPeObzEt53bcTIGSygUUiX8/n8f3w/8Mk=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,g={},j=[];function f(e){const n={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,r.jsx)(a(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,r.jsx)(n.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"Responses of Signer Widgets:"})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"2",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"5",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"6",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"7",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"8",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"9",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"10",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"11",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"12",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"13",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"14",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"15",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"Responses of Prefill widgets"})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"2",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"5",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,r.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,r.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,r.jsx)(p(),{...t(86803)}),"\n",(0,r.jsx)(c(),{...t(34673)}),"\n",(0,r.jsx)(x(),{...t(54903)})]})}function T(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(f,{...e})}):f(e)}},86803(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of template that needs to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"strng"}}]}')},34673(e){e.exports={title:"Body"}},54903(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"title":{"type":"string","example":"sample template"},"note":{"type":"string","example":"template note"},"description":{"type":"string","example":"template description"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"sender_name":{"type":"string","example":"opensign"},"sender_email":{"type":"string","example":"mailer@opensignlabs.com"},"notify_on_signatures":{"type":"boolean","example":false},"merge_certificate":{"type":"boolean","example":false},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"name":{"type":"string","example":"folder name"}},"title":"template_folder"},"file":{"type":"string","example":"https://templateuser.com"},"owner":{"type":"string","example":"template creator name"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"},"color":{"type":"string","format":"string","example":"black"},"fontSize":{"type":"number","format":"number","example":12},"hide_text_with_asterisks":{"type":"boolean","format":"boolean","example":false}}}},"title":"template_Signers_widgets_details"}}},"title":"template_Signers_details"}},"sendInOrder":{"type":"boolean","example":true},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","example":0},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"xml":{"name":"template_details"},"title":"template_details"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Template not found!"}},"title":"inline_response_404_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]);
Reference in New Issue View Git Blame Copy Permalink