mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-28 12:34:57 +02:00
1 line
26 KiB
JavaScript
1 line
26 KiB
JavaScript
"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5342],{64875(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>b,default:()=>k,frontMatter:()=>g,metadata:()=>r,toc:()=>y});const r=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":"eJztG8ty3DbyV7C4bDxFzUsjyZ5TtInLccUVuyx5XbuSagKSPUNYIMAAoEYT1VTlsH+wp73up+VLthogOeS89LCiaKvGB3kIdAP9QqPRQN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRiW77Bdd+mq25dV4vPdaZ30L2TsurTPlBXOMQoUrlXzsGtDnahxmcXSC1l5T5oGHMhyNSn5VB5vceLiPuvmuo8PGio86C59jaqc5POtgTKiOLZPC8OzbDoqsnZjVm2r25+Tdn1H+NM1zvab7ijl094pmvKpDvo9A46Ww91nTjuPPRQ50yPkJXE5GMF8b2jfmOb2t/mK55JEF9XwC3h+2ME6Surf/BHhG9LFn3U+xPCt69VxkqU9mjiJyvJ2a+P0Ja2yVcNt/qqX5f3wcHXybtOzZLQzin/+9/ef5x2f3wzUcfHx8c/nXxKXn+aHB8fp/jdbrdXAjsaUJWBdgfCtzEd0gnY8vKJBjRjmqVgQeP9140jgw5peU814jENKMf7r4zZhC5fir39Hre0EprYhFkiAWKD12EhkDHYKAEco2ScDh3b1NiZwJkMTzOBhMB1JlQMdOhVT02UQMro8MYpCiGt5nJCg8Jh+hY5ofP5RVAJySBCv9vF/5qkmjyKwJhxLkglDxrQSEkL0iI8yzLBI9fR+WIQ6WaVChV+gcii4DQOY7mf0jejfLfT61vgmjmuh/S690MoU9P/MKHzgLok87ohFgjG/ahEjlhS2VuQKgU50PmSFu+EWceYBzQDOXKr0tTwmdZshvZiITWr485rA59RvO10doHW4VY1vZgH1ICMQY+8HW6jTGUgMeFIF0ju8mc7FkKA/rZEFiw07UilhRj5eDZSclTdfdaZCJUSwGR9NGep84CmoCcwitAaxmhAcDe0sRIx6Keyrdsl6ulx2Ug6X1jjwhkUBCPp/DY7TazNzLDTKZFzA7qUtJrKBt/b7M7dgquSqsDlmOFOVrdBmlrdRnoE6m4C+6KAhODIuoPpfVEQAnxbNJSyyBIlb5lmcHDY7+2/POohfHFseDj/vvd+llSE+o5eNqmj++NyHb1qqdB784Be3xOnPxjMAzq7J9YRTjW9J9L+y3lAk3siDQ7Rjv0Gf7vMN5nSHWXuHO198b1LdW5G2hP+67211kexbDjtrnVw1WAbfd58rVvx71TMqDDtUfF6hm6HXkB5//9WvtdNd7qGDIw9UKDoVCA+ttsXXr/b39/rdfe6R6e9w+Hg1fDgsN3tdv9JA3qdioVi3aGvtn9X33kWP8k8IFko4FTld2NfQ8w1RHaU67U+a5tZ4XTu1dMoVbHf7pbWwJYdj+VWjTSkXN6qqRLF8hRO1XcKWy18z2ZmnR03Qz3EwQA0KrBIzGaGcENyA7HrYCLK3fYC1xnXM4KCxEh2pnJdvbe6ZX0cOEkiLyMlIxhxOYIr0Gt9VoXVnQc0jKKHBk24izZ2kMA19RttGEZlPsu0zjU1ZfUPlZOISVLeRRaLkEwTHiWuB9IQYhLCWGkguNLwTZpVxO/EK77uuW5Qq6/5ELLI9xIlC45tUsqAmETlIiYsy4DpNhoPQfM4a7W+hzCfkE9vW62Lb8pAh2VZezms7MQImMXjF02rw0nc+bn9wJ2zycw1idSe0jGXOPg3AsaW5FkGmkRKS9AvyFirtGDw+TDX7W7a4pvszf4v2dvvbopFmtx95rFN0Pd4yv8UWgfdTSFQk9YfgE8S+ycT+7L7GKHXWt9RZhFuDeS3RmULSDzcFhGY2RCB1eMt/2+xvZdOHNuagUAVDVVR0JpIqRZHzQM6WJcUOVEp2AQd+hSkJVOt5CQgmQBmgFg9I2zCuCQ4nP7L42VLQOvbRHc/yupS41JwCaNSl6NBtzvqVUIYrArhtJYdIWOVy/hpWV03/3aGBqPDiqGDVYbeSvcGxL1QP1WXIJ+Wn/r01k+/asHcA7l+2mC23u6ZNBDlmtuZy1Be77GM7/n+4dkFJv/QUlSR2nQpTZvQIa1SD52bWjpzTnE8fVUmPF0IXGUrDJNxqK5XfRbLeOeq18Yj+DLOWh+3BR7yvfuiGMsmXE5uw7tYiOoE1ek11hDYIijL+I+AUVmhjzpUkfFNgLl0zxy/x8ohF1p6n4HEg5jTsZt8ZVsDESkfhqNjb7VKlN//9d8Kq9Wqgm1nja6K4X2uSaamoDFVy2RMxgKueSh8xQWkrq+quTDAUgHGiBnh0sJEu2Qln3DLBCkeJJKIZSzkgqMRI5jygX5tHZg2+ZwA3ldg1181EEZiuBJo+gSPLWmzFoNMlb4cY/FHQBgJc8MlGENAJkxGCFgqIiBKE4yi8XVBprkBrNpAorknTUmrWWRJyiSbAI4dkLqsYhAcrZVoFebGEqNE7igm6N2V9icax4/LvDsZvsZkuvZbM56CNCRoNVdAJjmPwQQkUjEQn0xGFiRG+MaSDGnhEbgEfi6Fii6d/sa5ECRT6EE4ExgB1GlEdKuZNLhtF4eoQgWVwDKtMP9elap8MoAKfsflpa9N2SNnlVl9htBwC4tAYjqdrlj+iybOG25/yEPyETJluFV6tsCecJvkoVst9UGqDz/SG5DgzKe2FhZjxCoya2IZFZlOAiLrnIBFCzGd4w9vndN9QX7/7d/kHTAtSaKm3lijXIOYkUk5FUrOa96LrfKZrgSI5TZBiUfe+PAOBYwtJfg5Yfb33/5jyE8wJVwWKwpZabU+5KHg0aLKqNUaku9c1qO6OjD+ugaPeCEQkzA0pSvOCCOZxxZcXrbJsZxhmKd99REaA7Y7vAYbKJdarVLI8LCtpMNYV/dkE0gNiCswOBbufSEQiLlFi060yid+tjoxBXPFE4rP5ROKITmOY5I1X1agwGvk+POrTWBGmD/I2vbyYwzfk2eZ0kgF98SPFeY7UAEg40xhgdaQxJqN7WL8YGHovm5LyTVNXoSsEkdQDFOpxK/EguOqte1u8Zb8eNPdahiDy1w4thd6yXhhTmelWRK01q8xax/7SssiF0wUmW/cUNZeq1jQqXk/PgF9xaPyZmDDiu444A4NqOARFIF4sUEdv/nwjlztt7uY86h2xzss7s67t9+9/unkNRKDjtQLrNfutrsuX6CMTZmszVSv8lve124WcdSuInBXEbirCNxVBO4qAh8mpF1F4K4icFcRuPX16K4icFcRSJ7NQ/ZdReCuInBXEbirCNxVBO4qAncVgbuKwPNdReDDNLWrCNxVBO4qAncVgbuKwF1F4J9TEVg8AkGH3ckE4+4JTvEa3D+fOavekdGADuv1gBcBTZSxCHJzg7e8n7SYz7H5l9w9fz67COgV0xzfpLs3NjE3+Duuavs2Xql987GQxgty99LCtcyUz1wkvnFxlomP1wN6CbOl+sY5vpcu3rogtR7iOIogszXclUdTjZdHb16fUve+PWm+sbl0b2yKHzj6Wrqaj288AfgXXwKtRbi58e935vMK3ndtxCgYLKFRSBfz+fx/kMUSow==","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 s=t(74848),i=t(28453),a=t(57742),l=t.n(a),o=t(78178),p=t.n(o),d=t(19624),c=t.n(d),m=t(96226),h=t.n(m),x=(t(77675),t(19365),t(51107)),u=t(21312);const g={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:"eJztG8ty3DbyV7C4bDxFzUsjyZ5TtInLccUVuyx5XbuSagKSPUNYIMAAoEYT1VTlsH+wp73up+VLthogOeS89LCiaKvGB3kIdAP9QqPRQN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRiW77Bdd+mq25dV4vPdaZ30L2TsurTPlBXOMQoUrlXzsGtDnahxmcXSC1l5T5oGHMhyNSn5VB5vceLiPuvmuo8PGio86C59jaqc5POtgTKiOLZPC8OzbDoqsnZjVm2r25+Tdn1H+NM1zvab7ijl094pmvKpDvo9A46Ww91nTjuPPRQ50yPkJXE5GMF8b2jfmOb2t/mK55JEF9XwC3h+2ME6Surf/BHhG9LFn3U+xPCt69VxkqU9mjiJyvJ2a+P0Ja2yVcNt/qqX5f3wcHXybtOzZLQzin/+9/ef5x2f3wzUcfHx8c/nXxKXn+aHB8fp/jdbrdXAjsaUJWBdgfCtzEd0gnY8vKJBjRjmqVgQeP9140jgw5peU814jENKMf7r4zZhC5fir39Hre0EprYhFkiAWKD12EhkDHYKAEco2ScDh3b1NiZwJkMTzOBhMB1JlQMdOhVT02UQMro8MYpCiGt5nJCg8Jh+hY5ofP5RVAJySBCv9vF/5qkmjyKwJhxLkglDxrQSEkL0iI8yzLBI9fR+WIQ6WaVChV+gcii4DQOY7mf0jejfLfT61vgmjmuh/S690MoU9P/MKHzgLok87ohFgjG/ahEjlhS2VuQKgU50PmSFu+EWceYBzQDOXKr0tTwmdZshvZiITWr485rA59RvO10doHW4VY1vZgH1ICMQY+8HW6jTGUgMeFIF0ju8mc7FkKA/rZEFiw07UilhRj5eDZSclTdfdaZCJUSwGR9NGep84CmoCcwitAaxmhAcDe0sRIx6Keyrdsl6ulx2Ug6X1jjwhkUBCPp/DY7TazNzLDTKZFzA7qUtJrKBt/b7M7dgquSqsDlmOFOVrdBmlrdRnoE6m4C+6KAhODIuoPpfVEQAnxbNJSyyBIlb5lmcHDY7+2/POohfHFseDj/vvd+llSE+o5eNqmj++NyHb1qqdB784Be3xOnPxjMAzq7J9YRTjW9J9L+y3lAk3siDQ7Rjv0Gf7vMN5nSHWXuHO198b1LdW5G2hP+67211kexbDjtrnVw1WAbfd58rVvx71TMqDDtUfF6hm6HXkB5//9WvtdNd7qGDIw9UKDoVCA+ttsXXr/b39/rdfe6R6e9w+Hg1fDgsN3tdv9JA3qdioVi3aGvtn9X33kWP8k8IFko4FTld2NfQ8w1RHaU67U+a5tZ4XTu1dMoVbHf7pbWwJYdj+VWjTSkXN6qqRLF8hRO1XcKWy18z2ZmnR03Qz3EwQA0KrBIzGaGcENyA7HrYCLK3fYC1xnXM4KCxEh2pnJdvbe6ZX0cOEkiLyMlIxhxOYIr0Gt9VoXVnQc0jKKHBk24izZ2kMA19RttGEZlPsu0zjU1ZfUPlZOISVLeRRaLkEwTHiWuB9IQYhLCWGkguNLwTZpVxO/EK77uuW5Qq6/5ELLI9xIlC45tUsqAmETlIiYsy4DpNhoPQfM4a7W+hzCfkE9vW62Lb8pAh2VZezms7MQImMXjF02rw0nc+bn9wJ2zycw1idSe0jGXOPg3AsaW5FkGmkRKS9AvyFirtGDw+TDX7W7a4pvszf4v2dvvbopFmtx95rFN0Pd4yv8UWgfdTSFQk9YfgE8S+ycT+7L7GKHXWt9RZhFuDeS3RmULSDzcFhGY2RCB1eMt/2+xvZdOHNuagUAVDVVR0JpIqRZHzQM6WJcUOVEp2AQd+hSkJVOt5CQgmQBmgFg9I2zCuCQ4nP7L42VLQOvbRHc/yupS41JwCaNSl6NBtzvqVUIYrArhtJYdIWOVy/hpWV03/3aGBqPDiqGDVYbeSvcGxL1QP1WXIJ+Wn/r01k+/asHcA7l+2mC23u6ZNBDlmtuZy1Be77GM7/n+4dkFJv/QUlSR2nQpTZvQIa1SD52bWjpzTnE8fVUmPF0IXGUrDJNxqK5XfRbLeOeq18Yj+DLOWh+3BR7yvfuiGMsmXE5uw7tYiOoE1ek11hDYIijL+I+AUVmhjzpUkfFNgLl0zxy/x8ohF1p6n4HEg5jTsZt8ZVsDESkfhqNjb7VKlN//9d8Kq9Wqgm1nja6K4X2uSaamoDFVy2RMxgKueSh8xQWkrq+quTDAUgHGiBnh0sJEu2Qln3DLBCkeJJKIZSzkgqMRI5jygX5tHZg2+ZwA3ldg1181EEZiuBJo+gSPLWmzFoNMlb4cY/FHQBgJc8MlGENAJkxGCFgqIiBKE4yi8XVBprkBrNpAorknTUmrWWRJyiSbAI4dkLqsYhAcrZVoFebGEqNE7igm6N2V9icax4/LvDsZvsZkuvZbM56CNCRoNVdAJjmPwQQkUjEQn0xGFiRG+MaSDGnhEbgEfi6Fii6d/sa5ECRT6EE4ExgB1GlEdKuZNLhtF4eoQgWVwDKtMP9elap8MoAKfsflpa9N2SNnlVl9htBwC4tAYjqdrlj+iybOG25/yEPyETJluFV6tsCecJvkoVst9UGqDz/SG5DgzKe2FhZjxCoya2IZFZlOAiLrnIBFCzGd4w9vndN9QX7/7d/kHTAtSaKm3lijXIOYkUk5FUrOa96LrfKZrgSI5TZBiUfe+PAOBYwtJfg5Yfb33/5jyE8wJVwWKwpZabU+5KHg0aLKqNUaku9c1qO6OjD+ugaPeCEQkzA0pSvOCCOZxxZcXrbJsZxhmKd99REaA7Y7vAYbKJdarVLI8LCtpMNYV/dkE0gNiCswOBbufSEQiLlFi060yid+tjoxBXPFE4rP5ROKITmOY5I1X1agwGvk+POrTWBGmD/I2vbyYwzfk2eZ0kgF98SPFeY7UAEg40xhgdaQxJqN7WL8YGHovm5LyTVNXoSsEkdQDFOpxK/EguOqte1u8Zb8eNPdahiDy1w4thd6yXhhTmelWRK01q8xax/7SssiF0wUmW/cUNZeq1jQqXk/PgF9xaPyZmDDiu444A4NqOARFIF4sUEdv/nwjlztt7uY86h2xzss7s67t9+9/unkNRKDjtQLrNfutrsuX6CMTZmszVSv8lve124WcdSuInBXEbirCNxVBO4qAh8mpF1F4K4icFcRuPX16K4icFcRSJ7NQ/ZdReCuInBXEbirCNxVBO4qAncVgbuKwPNdReDDNLWrCNxVBO4qAncVgbuKwF1F4J9TEVg8AkGH3ckE4+4JTvEa3D+fOavekdGADuv1gBcBTZSxCHJzg7e8n7SYz7H5l9w9fz67COgV0xzfpLs3NjE3+Duuavs2Xql987GQxgty99LCtcyUz1wkvnFxlomP1wN6CbOl+sY5vpcu3rogtR7iOIogszXclUdTjZdHb16fUve+PWm+sbl0b2yKHzj6Wrqaj288AfgXXwKtRbi58e935vMK3ndtxCgYLKFRSBfz+fx/kMUSow==",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,j={},y=[];function f(e){const n={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,s.jsx)(l(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Responses of Signer Widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Responses of Prefill widgets"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...t(86803)}),"\n",(0,s.jsx)(c(),{...t(34673)}),"\n",(0,s.jsx)(h(),{...t(54903)})]})}function k(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.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},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"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"}}}}}}')}}]); |