mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-27 20:14:53 +02:00
1 line
25 KiB
JavaScript
1 line
25 KiB
JavaScript
"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5342],{64875(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>g,default:()=>v,frontMatter:()=>y,metadata:()=>r,toc:()=>j});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+VLthogOeS89LCiaKvGB3kIdAP9QqMBdN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRi232D675NV926rhaf60zvoHsnZdWnfaCucIhRpHKvnINbHexCjc8ukFq6lfugYcyFIFN/LYfK6z1eRNx/1VTn4UFDnQfNtbdRnZt0tiVQRhTP5nlxaIZFV03ObsyyfXXza8qu/xhnut7RfsMdvXzCM11TJt1Bp3fQ2Xqo68Rx56GHOmd6hKxcTD5WEN876je2qf1tvuKZBPF1BdwSvj9GkL6y+gd/RPi2ZNFHvT8hfPtaZaxEaY8mfrJyOfv1EdrSNvmq4VZf9evyPjj4OnnXqVkS2jnlf//b+4/T7o9vJur4+Pj4p5NPyetPk+Pj4xS/2+32SmBHA6oy0O5A+DamQzoBWz4+0YBmTLMULGh8/7pxZNAhLd+pRjymAeX4/pUxm9DlR7G33+OWVkITmzBLJEBs8DksBDIGGyWAY5SM06Fjmxo7EziT4WkmkBC4zoSKgQ696qmJEkgZHd44RSGk1VxOaFA4TN8iJ3Q+vwgqIRlE6He7+F+TVJNHERgzzgWp5EEDGilpQVqEZ1kmeOQ6Ol8MIt2sUqHCLxBZFJzGYSz3U/pmlO92en0LXDPH9ZBe934IZWr6HyZ0HlB3ybxuiAWCcT8qkSOWVPYWpEpBDnS+pMU7YdYx5gHNQI7cqjQ1fKY1m6G9WEjN6rjz2sBnFF87nV2gdbhVTS/mATUgY9Ajb4fbKFMZSLxwpAsk9/izHQshQH9bIgsWmnak0kKMfDwbKTmq3j7rTIRKCWCyPpqz1HlAU9ATGEVoDWM0ILgb2liJGPRT2dbtEvX0uNtIOl9Y48IZFAQj6fw2O02szcyw0ymRcwO6lLSaygbf2+zOvYKrkqrA3THDnaxugzS1uo30CNTdBPZFAQnBkXUH0/uiIAT4tmgoZZElSt4yzeDgsN/bf3nUQ/ji2PBw/n3v/SypCPUdvWxSR/fH5Tp61VKh9+YBvb4nTn8wmAd0dk+sI5xqek+k/ZfzgCb3RBocoh37Df52mW8ypTvK3Dna++J7l+rcjLQn/Nd7a62PYtlw2l3r4KrBNvq8+Vq34vNUzKgw7VGRPUO3Qy+gvP9/K9/rpjtdQwbGHihQdCoQH9vtC6/f7e/v9bp73aPT3uFw8Gp4cNjudrv/pAG9TsVCse7QV9u/q+88i59kHpAsFHCq8ruxryHmGiI7yvVan7XNrHA6l/U0SlXst7ulNbBlx2O5VSMNKZe3aqpE8dAjJSMYcTmCK9BrvUKF2EUn5e9Y1i3MZlD4D5WTiElSvsQVJkimCY8S1wNpCDEJYaw0ELQzzMiyivh9aGWlP1f3vJrLhpDFbSdRsuDYJqUMiElULmLCsgyYbpPcAFG5Jmet1vcQ5hPy6W2rdfFNuc2zLGsvB1WdGAGzePwCBRYxEeXFKQGIOz22H7hvNJm5JpHaUzrmEgf/RsDYkjzLQJNIaQn6BRlrlRYMPh/mut1NG1yTvdn/JXv73U07cZO7zzy2CZ4hPeV/Cq2D7qYAoEnrD8Anif2TiX3ZfYzAY63vKM/Qt4axW2OSBSQe7Yr4w2yIP+rRhv+32NxKJ45tzW2wigWqGGBNnFCLIuYBHay7EjhRKdgEHfoUpCVTreQkIJkAZoBYPSNswrgkOJz+y+PdFYDWt4nufpTVpcal4BJGpS5Hg2531KuEMFgVwmntboCMVS7jp2V13fzbGRqMDiuGDlYZeitdBoTLzz5VlyCflp/69NZPv2rB3AO5ftpgtt7umTQQ5Zrbmbufu95jGd/z/cOzC7z6QktRxcWeu9CzCR3S6uDduald5s0pjqevyus+FwBWZ3XDZByq61WfxTLeueq18QC6jLPWx22Bh3zvvijGsgmXk9vwLhaiOkF1eo01BLYIyjL+I2BUVuijDlXcdybA3GXHHL/HyiEXWnqfgcRjiNOxm3xlWwMRqRTQxaNjb7VKlN//9d8Kq9WqUvudNboc/ve5JpmagsaLSiZjMhZwzUPh6w0gdX1VxYEBlgowRswIlxYm2l3V8Qm3TJAiHY9ELGMhFxyNGMEUYmtSWwemTT4ngLf12PVXDYSRGK5AoO0TjNrTZikCmSp9Ocbah4AwEuaGSzCGgEyYjBCw1ERAlCYYRuPjeqa5ASxaQKq5p01Jq1lkScokmwCOHZC6sGIQHM2VaBXmxhKjRO5IJujelYaYlAy5i2cnxNd4l6z93ozJqBoSNJsrIJOcx2ACEqkYiL9LRRYkhvjGkgxp4RG4++tcChVdOgWOcyFIptCFcCYwBKjTiOhWM2lw3/a0lDqoBJZphdfPVaXGJwOo4XdcXvrSjD1yVtnVZwgNt7CIJKbT6Yrpv2jivOH2hzwkHyFThlulZwvsCbdJHrrlUh+k+vAjvQEJzn5qi2ExRqwisyaYUZHpJCCyzglYtBDTOf7w1nndF+T33/5N3gHTkiRq6q01yjWIGZmUU6HkvOa92Cqn6SpgWG4TlHjkjQ+fEMDYUoKfE2Z//+0/hvwEU8JlsaSQlVbrQx4KHi2KbFqtIfnOHfqrm3PjXyvwjBcCMQlDU7rijDCSeWzB5WWbHMsZxnnaF9+gMWC7w2uwgXKpleqEzECMByvEWFf2YxNIDYgrMDgWbn4hEIi5RYtOtMonfrY6MQVzRQbB5zKDYEiO45hkzcQCFHiNHH+AtQnMCPMnWdtezkXwPXmWKY1UcE/8WOFxHxUAMs4U1icNSazZ2C7GDxaG7suWlFzT5EXIKnEExTCVSvxKLDiuWtvuEWvJkTf9rYYxaJzQsb3QS8YLczorzZKgtX6NWfvgV1oWuWiiuPjFHWXtq4IFnZr34xPQVzwqL8Y3rOiOA+7QgAoeQRGJFzvU8ZsP78jVfrtLg9r2eIfF3Xn39rvXP528RmLQkXqB9drddtddGChjUyZrM9WL3JY3tptFILUriNsVxO0K4nYFcbuCuIcJaVcQtyuI2xXEbU2e3BXE7QriyLPJ494VxO0K4nYFcbuCuF1B3K4gblcQtyuIO98VxD1MU7uCuF1B3K4gblcQtyuI2xXE/TkFcUUWCDrsTiYYdzk4RTK0z585qxLJaECH9XK4i4AmylgEubnBV95PWszn2PxL7nKTzy4CesU0x5Rsl2QTc4O/46q0beOT2jcfC2m8IHevrFvLTJnnIjHJxVkm5m4H9BJmS+V9c6y6KpJdkFoPcRxFkNka7krWVCP16M3rU+rSu5Nmks2lS7IpfuDoa+lqZt94AvAvpgKtRbi58Qk883kF77s2YhQMltAopIv5fP4/ebu41A==","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),l=t(28453),i=t(57742),a=t.n(i),o=t(78178),p=t.n(o),d=t(19624),c=t.n(d),m=t(96226),x=t.n(m),h=(t(77675),t(19365),t(51107)),u=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:"eJztG8ty3DbyV7C4bDxFzUsjyZ5TtInLccUVuyx5XbuSagKSPUNYIMAAoEYT1VTlsH+wp73up+VLthogOeS89LCiaKvGB3kIdAP9QqMBdN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRi232D675NV926rhaf60zvoHsnZdWnfaCucIhRpHKvnINbHexCjc8ukFq6lfugYcyFIFN/LYfK6z1eRNx/1VTn4UFDnQfNtbdRnZt0tiVQRhTP5nlxaIZFV03ObsyyfXXza8qu/xhnut7RfsMdvXzCM11TJt1Bp3fQ2Xqo68Rx56GHOmd6hKxcTD5WEN876je2qf1tvuKZBPF1BdwSvj9GkL6y+gd/RPi2ZNFHvT8hfPtaZaxEaY8mfrJyOfv1EdrSNvmq4VZf9evyPjj4OnnXqVkS2jnlf//b+4/T7o9vJur4+Pj4p5NPyetPk+Pj4xS/2+32SmBHA6oy0O5A+DamQzoBWz4+0YBmTLMULGh8/7pxZNAhLd+pRjymAeX4/pUxm9DlR7G33+OWVkITmzBLJEBs8DksBDIGGyWAY5SM06Fjmxo7EziT4WkmkBC4zoSKgQ696qmJEkgZHd44RSGk1VxOaFA4TN8iJ3Q+vwgqIRlE6He7+F+TVJNHERgzzgWp5EEDGilpQVqEZ1kmeOQ6Ol8MIt2sUqHCLxBZFJzGYSz3U/pmlO92en0LXDPH9ZBe934IZWr6HyZ0HlB3ybxuiAWCcT8qkSOWVPYWpEpBDnS+pMU7YdYx5gHNQI7cqjQ1fKY1m6G9WEjN6rjz2sBnFF87nV2gdbhVTS/mATUgY9Ajb4fbKFMZSLxwpAsk9/izHQshQH9bIgsWmnak0kKMfDwbKTmq3j7rTIRKCWCyPpqz1HlAU9ATGEVoDWM0ILgb2liJGPRT2dbtEvX0uNtIOl9Y48IZFAQj6fw2O02szcyw0ymRcwO6lLSaygbf2+zOvYKrkqrA3THDnaxugzS1uo30CNTdBPZFAQnBkXUH0/uiIAT4tmgoZZElSt4yzeDgsN/bf3nUQ/ji2PBw/n3v/SypCPUdvWxSR/fH5Tp61VKh9+YBvb4nTn8wmAd0dk+sI5xqek+k/ZfzgCb3RBocoh37Df52mW8ypTvK3Dna++J7l+rcjLQn/Nd7a62PYtlw2l3r4KrBNvq8+Vq34vNUzKgw7VGRPUO3Qy+gvP9/K9/rpjtdQwbGHihQdCoQH9vtC6/f7e/v9bp73aPT3uFw8Gp4cNjudrv/pAG9TsVCse7QV9u/q+88i59kHpAsFHCq8ruxryHmGiI7yvVan7XNrHA6l/U0SlXst7ulNbBlx2O5VSMNKZe3aqpE8dAjJSMYcTmCK9BrvUKF2EUn5e9Y1i3MZlD4D5WTiElSvsQVJkimCY8S1wNpCDEJYaw0ELQzzMiyivh9aGWlP1f3vJrLhpDFbSdRsuDYJqUMiElULmLCsgyYbpPcAFG5Jmet1vcQ5hPy6W2rdfFNuc2zLGsvB1WdGAGzePwCBRYxEeXFKQGIOz22H7hvNJm5JpHaUzrmEgf/RsDYkjzLQJNIaQn6BRlrlRYMPh/mut1NG1yTvdn/JXv73U07cZO7zzy2CZ4hPeV/Cq2D7qYAoEnrD8Anif2TiX3ZfYzAY63vKM/Qt4axW2OSBSQe7Yr4w2yIP+rRhv+32NxKJ45tzW2wigWqGGBNnFCLIuYBHay7EjhRKdgEHfoUpCVTreQkIJkAZoBYPSNswrgkOJz+y+PdFYDWt4nufpTVpcal4BJGpS5Hg2531KuEMFgVwmntboCMVS7jp2V13fzbGRqMDiuGDlYZeitdBoTLzz5VlyCflp/69NZPv2rB3AO5ftpgtt7umTQQ5Zrbmbufu95jGd/z/cOzC7z6QktRxcWeu9CzCR3S6uDduald5s0pjqevyus+FwBWZ3XDZByq61WfxTLeueq18QC6jLPWx22Bh3zvvijGsgmXk9vwLhaiOkF1eo01BLYIyjL+I2BUVuijDlXcdybA3GXHHL/HyiEXWnqfgcRjiNOxm3xlWwMRqRTQxaNjb7VKlN//9d8Kq9WqUvudNboc/ve5JpmagsaLSiZjMhZwzUPh6w0gdX1VxYEBlgowRswIlxYm2l3V8Qm3TJAiHY9ELGMhFxyNGMEUYmtSWwemTT4ngLf12PVXDYSRGK5AoO0TjNrTZikCmSp9Ocbah4AwEuaGSzCGgEyYjBCw1ERAlCYYRuPjeqa5ASxaQKq5p01Jq1lkScokmwCOHZC6sGIQHM2VaBXmxhKjRO5IJujelYaYlAy5i2cnxNd4l6z93ozJqBoSNJsrIJOcx2ACEqkYiL9LRRYkhvjGkgxp4RG4++tcChVdOgWOcyFIptCFcCYwBKjTiOhWM2lw3/a0lDqoBJZphdfPVaXGJwOo4XdcXvrSjD1yVtnVZwgNt7CIJKbT6Yrpv2jivOH2hzwkHyFThlulZwvsCbdJHrrlUh+k+vAjvQEJzn5qi2ExRqwisyaYUZHpJCCyzglYtBDTOf7w1nndF+T33/5N3gHTkiRq6q01yjWIGZmUU6HkvOa92Cqn6SpgWG4TlHjkjQ+fEMDYUoKfE2Z//+0/hvwEU8JlsaSQlVbrQx4KHi2KbFqtIfnOHfqrm3PjXyvwjBcCMQlDU7rijDCSeWzB5WWbHMsZxnnaF9+gMWC7w2uwgXKpleqEzECMByvEWFf2YxNIDYgrMDgWbn4hEIi5RYtOtMonfrY6MQVzRQbB5zKDYEiO45hkzcQCFHiNHH+AtQnMCPMnWdtezkXwPXmWKY1UcE/8WOFxHxUAMs4U1icNSazZ2C7GDxaG7suWlFzT5EXIKnEExTCVSvxKLDiuWtvuEWvJkTf9rYYxaJzQsb3QS8YLczorzZKgtX6NWfvgV1oWuWiiuPjFHWXtq4IFnZr34xPQVzwqL8Y3rOiOA+7QgAoeQRGJFzvU8ZsP78jVfrtLg9r2eIfF3Xn39rvXP528RmLQkXqB9drddtddGChjUyZrM9WL3JY3tptFILUriNsVxO0K4nYFcbuCuIcJaVcQtyuI2xXEbU2e3BXE7QriyLPJ494VxO0K4nYFcbuCuF1B3K4gblcQtyuIO98VxD1MU7uCuF1B3K4gblcQtyuI2xXE/TkFcUUWCDrsTiYYdzk4RTK0z585qxLJaECH9XK4i4AmylgEubnBV95PWszn2PxL7nKTzy4CesU0x5Rsl2QTc4O/46q0beOT2jcfC2m8IHevrFvLTJnnIjHJxVkm5m4H9BJmS+V9c6y6KpJdkFoPcRxFkNka7krWVCP16M3rU+rSu5Nmks2lS7IpfuDoa+lqZt94AvAvpgKtRbi58Qk883kF77s2YhQMltAopIv5fP4/ebu41A==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,b={},j=[];function f(e){const n={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,s.jsx)(a(),{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)(h.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)(x(),{...t(54903)})]})}function v(e={}){const{wrapper:n}={...(0,l.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},"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"}}}}}}')}}]); |