WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-12 20:57:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
a601ed53c19eec7ffd1992220d2f6a031cf07b53
OpenSign/assets/js/05632a52.e48c3f6b.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxA4fKfdeXtGM8+MN4JkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnU34lEOOlljYSeI9oII2sUqejvr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0taXiCKxmtpML9Ms2q/LhymWjbGbsNzpqAgQ0dTyb8tR9uaPIcQ5g3GnYZEUkEi4ZYXjqnVR4vxjeBlTYPo+tQc+48myHVudwm49E4qmlWrY5vnGiTPv+PM3BjETJEVsdaKv0/9DPEV/3BKLc1m3KVNY8O5WT6fHocP2wi9ygJi1M6ZOZO6Xhy/PxoOjmafH85fZme/JC+eDmaTCZ/ikSs6oimr8pCUkRJivTwuXHFN/DT3hfrK75vwKHCthfalrVODtXiha2RKmVKWKIhWHprygScRhkQyK9BllIZ0JLQP/l6RYreW//lND0usnYAWxmtDF5vG/H6ZDK5nu6ScPIwCVt6M5ZgbhtTfFukB9x/Gc7J9fEOzouHcM7NQmpVRLa+tLdovi2coXvq3D8sWtUJxXuxB3Z43oEMmDde0TpOhtWRdOqou0+vZsy4XCe2nyhxlFAlUjHuq3+8uZsirWBrfrEdM43XIhUVkQvpeCydG1mHJqjSaJkFpqCxdGq8YBq5Lx1IlsqUR1/Umt1Ff8EZ7pK4h2GXSunUr7gWW/Ldk+qnX4WyQB/TqczcRuU+ce8cmgtVmpj2xfTBjPyAOrc18symCmEr/s9ff0eNwuZNjYZiVTyBd40HZ5foeUhJU8Bc40plGg+sAAFlrTEEvQZlCEsvCaFQpSKpgbPCPZxLJzOlFdcRi1nW9jAoxTCCDxVShZ6vvvMIEgpcoObyA23tLdshC7IhW0cffcywtP52ziElICFrgjIYAgTErQqaSpocYfsuErAepAE0hN55FRCkqll4bj3gfK5yxYa5cjy3Zi2NLJGdJcBxcxactwtVYABvsyYQBKubCIQ91ojUQTSIRRjBz2qBHXA+7MgaCygbNpFAbguEvocYhikgw0Dg2L3KMRoNJD2BxgX6WHvxTc4brcFZbm4lNa9Aw3fLhshLE3hcdgFtX80ufc5b3keij0KuR/DRfDRMv9AE5ALQytyG9KM5gqtdmX3ALCjC2dNtPyyXywd98Gxf50xR1WTg0dk7vTIexq4Zqu8enolEEPo6vJtfoF+oHPsm/IzPcRQe95TH449pq1tIuMde3Vdg+tEqRxNwQFCnZ+/fwgKejyYiGXT+fwh4/Pb89ZvfLt6wXWaarv+mo8loEhcaG6iWZuBqsGHfb9vNHW9/7WW8Zx3CFY2dlirScAS66Sn0Stwt0+lgFZ8lorKBWGCzyWTAP7xuWz7+1KBnmp4lYiG9khlT09VGFCrw72K3an8W5NPf+639GRze6g+GvWVQw/S5kLrhJ5GIW1zv/xfRztpky6IcWCdwmufoaKD6YELujZmzN5ciEbLhHA3Z+zayd/+DrR8Ma5/WuwD4L0+Ygwo/8ov+Fdc/7cS7m88q9Pi20pyiWdu2/wIzKM+Z",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxA4fKfdeXtGM8+MN4JkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnU34lEOOlljYSeI9oII2sUqejvr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0taXiCKxmtpML9Ms2q/LhymWjbGbsNzpqAgQ0dTyb8tR9uaPIcQ5g3GnYZEUkEi4ZYXjqnVR4vxjeBlTYPo+tQc+48myHVudwm49E4qmlWrY5vnGiTPv+PM3BjETJEVsdaKv0/9DPEV/3BKLc1m3KVNY8O5WT6fHocP2wi9ygJi1M6ZOZO6Xhy/PxoOjmafH85fZme/JC+eDmaTCZ/ikSs6oimr8pCUkRJivTwuXHFN/DT3hfrK75vwKHCthfalrVODtXiha2RKmVKWKIhWHprygScRhkQyK9BllIZ0JLQP/l6RYreW//lND0usnYAWxmtDF5vG/H6ZDK5nu6ScPIwCVt6M5ZgbhtTfFukB9x/Gc7J9fEOzouHcM7NQmpVRLa+tLdovi2coXvq3D8sWtUJxXuxB3Z43oEMmDde0TpOhtWRdOqou0+vZsy4XCe2nyhxlFAlUjHuq3+8uZsirWBrfrEdM43XIhUVkQvpeCydG1mHJqjSaJkFpqCxdGq8YBq5Lx1IlsqUR1/Umt1Ff8EZ7pK4h2GXSunUr7gWW/Ldk+qnX4WyQB/TqczcRuU+ce8cmgtVmpj2xfTBjPyAOrc18symCmEr/s9ff0eNwuZNjYZiVTyBd40HZ5foeUhJU8Bc40plGg+sAAFlrTEEvQZlCEsvCaFQpSKpgbPCPZxLJzOlFdcRi1nW9jAoxTCCDxVShZ6vvvMIEgpcoObyA23tLdshC7IhW0cffcywtP52ziElICFrgjIYAgTErQqaSpocYfsuErAepAE0hN55FRCkqll4bj3gfK5yxYa5cjy3Zi2NLJGdJcBxcxactwtVYABvsyYQBKubCIQ91ojUQTSIRRjBz2qBHXA+7MgaCygbNpFAbguEvocYhikgw0Dg2L3KMRoNJD2BxgX6WHvxTc4brcFZbm4lNa9Aw3fLhshLE3hcdgFtX80ufc5b3keij0KuR/DRfDRMv9AE5ALQytyG9KM5gqtdmX3ALCjC2dNtPyyXywd98Gxf50xR1WTg0dk7vTIexq4Zqu8enolEEPo6vJtfoF+oHPsm/IzPcRQe95TH449pq1tIuMde3Vdg+tEqRxNwQFCnZ+/fwgKejyYiGXT+fwh4/Pb89ZvfLt6wXWaarv+mo8loEhcaG6iWZuBqsGHfb9vNHW9/7WW8Zx3CFY2dlirScAS66Sn0Stwt0+lgFZ8lorKBWGCzyWTAP7xuWz7+1KBnmp4lYiG9khlT09VGFCrw72K3an8W5NPf+639GRze6g+GvWVQw/S5kLrhJ5GIW1zv/xfRztpky6IcWCdwmufoaKD6YELujZmzN5ciEbLhHA3Z+zayd/+DrR8Ma5/WuwD4L0+Ygwo/8ov+Fdc/7cS7m88q9Pi20pyiWdu2/wIzKM+Z",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Contact"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink