WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 20:44:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
1beb63cac7a5e7a2d2d3409164b7eb2a6faade0e
OpenSign/assets/js/a2bc1463.87a05c5b.js
T

1 line
9.9 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),d=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r40YQ/ivqfLqAbMtO7kpFKReOEMIdl1CnFJqYYy2NrYlXu3u7K8fG6L+XWcmx5CS9XikHIYlm5+WZmWdmdwdeLB2kd/BBKy8y72AWQ44us2Q8aQUpQAzaoBX8eZVDClmjKsl5iMEIK0r0aNnNDpQoEVLYDIShgdcrVBADsZ8CRY4WYrD4tSKLOaTeVhiD81vJNo5KIxFiwI2ROkdIF0I6VsgKLAWkO/BbEzS9JbWEmlVFMEoZo3K0VMPNZrOBOn6CIqkkvwfxtUK77WHYx2hBLLQtuxBaiMcIVFXO0fYQjJNOULci8wNiJvWM/TqjlUPHupMk4T/9Froqy9C5RSWjp1ZCHBqJyrO+MEZSFg5GD46Nds8B6PkDZqHnlt14akJadJX0HT1hreCEyWPpvm3fiJlaxw2OQ2mE70oOHTfFeF5sJg+GS/I51P37HDxojOaIbH5RCpL/wX6O+L4VDDNdsqubQqvvhnI2Ph1Pwg+7yCwKj/m5f8nNwWiSTE4H42SQ/Hw7fpee/ZK+fTdMkuQviGFThmxaNubChyw9edn9rkz+A+LUx2rtAsnRC5Kua9CeQF13hKQkKfyyp/kXpngdNM6St8/JfqXWQlIend9cRbe8gH76/6iO1mr7z8XqhvdN+OcVoEap2Y+9VLvyJkmHWWXJb8N67e7V9G7G41+iLzTv5SU2+9gXkMKov6Ud2vV+RVdW8jr23rh0NHJeLEktB8KY4X6HSjF3TOeRMDRaj4HD7GFMuVRNNXpgDtNv6CPy+H/zKuDsSC10MG4rcG1QTWmpQv3WYzi+jW4LchG5cJzrrCpR+dDLaKFtdGQdzYXDPNIq8gWGQ5afDseRM5jRoqXBMLpX92qqS4wqh7wlJamVS+/VILq7XiwoIyGjP3HuyOPszb5yj4+Pzyp2EmwuyRfVPLJo9EF9GYShrF2rp48TiMGjLd31Yop2TRm2XXol1Cgoj1py89QwQZs9the9PzZisknKUDns0PH88uZTdDpMIO6Q419AHn26+nDxeXrBXpleTYvGw2SYsMho50uhOoEu0UcttKhlZq+9u8Og8rujZZTHjR8ZKSjMSkC4a3l+13uNzGIotPMs3u24939YWdcsbu5gZn9OTsxl5xZe4bbzSlgLWXHM8IJ4Rbe93A+qM/6wxLphKuM9w18M+GrGb35vXwgn0WvJNwD6I9WD3CicZxmabjrPll5vc1xe3EIMouKKdud4Fea4/Ydz2R+pbcd3H00DgH8znBcNfuUp/Ijb357Um5NXDZ6ejo02l2JW1/Xf7z6b5g==",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/contactlist",title:"Get contact list",description:"",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r40YQ/ivqfLqAbMtO7kpFKReOEMIdl1CnFJqYYy2NrYlXu3u7K8fG6L+XWcmx5CS9XikHIYlm5+WZmWdmdwdeLB2kd/BBKy8y72AWQ44us2Q8aQUpQAzaoBX8eZVDClmjKsl5iMEIK0r0aNnNDpQoEVLYDIShgdcrVBADsZ8CRY4WYrD4tSKLOaTeVhiD81vJNo5KIxFiwI2ROkdIF0I6VsgKLAWkO/BbEzS9JbWEmlVFMEoZo3K0VMPNZrOBOn6CIqkkvwfxtUK77WHYx2hBLLQtuxBaiMcIVFXO0fYQjJNOULci8wNiJvWM/TqjlUPHupMk4T/9Froqy9C5RSWjp1ZCHBqJyrO+MEZSFg5GD46Nds8B6PkDZqHnlt14akJadJX0HT1hreCEyWPpvm3fiJlaxw2OQ2mE70oOHTfFeF5sJg+GS/I51P37HDxojOaIbH5RCpL/wX6O+L4VDDNdsqubQqvvhnI2Ph1Pwg+7yCwKj/m5f8nNwWiSTE4H42SQ/Hw7fpee/ZK+fTdMkuQviGFThmxaNubChyw9edn9rkz+A+LUx2rtAsnRC5Kua9CeQF13hKQkKfyyp/kXpngdNM6St8/JfqXWQlIend9cRbe8gH76/6iO1mr7z8XqhvdN+OcVoEap2Y+9VLvyJkmHWWXJb8N67e7V9G7G41+iLzTv5SU2+9gXkMKov6Ud2vV+RVdW8jr23rh0NHJeLEktB8KY4X6HSjF3TOeRMDRaj4HD7GFMuVRNNXpgDtNv6CPy+H/zKuDsSC10MG4rcG1QTWmpQv3WYzi+jW4LchG5cJzrrCpR+dDLaKFtdGQdzYXDPNIq8gWGQ5afDseRM5jRoqXBMLpX92qqS4wqh7wlJamVS+/VILq7XiwoIyGjP3HuyOPszb5yj4+Pzyp2EmwuyRfVPLJo9EF9GYShrF2rp48TiMGjLd31Yop2TRm2XXol1Cgoj1py89QwQZs9the9PzZisknKUDns0PH88uZTdDpMIO6Q419AHn26+nDxeXrBXpleTYvGw2SYsMho50uhOoEu0UcttKhlZq+9u8Og8rujZZTHjR8ZKSjMSkC4a3l+13uNzGIotPMs3u24939YWdcsbu5gZn9OTsxl5xZe4bbzSlgLWXHM8IJ4Rbe93A+qM/6wxLphKuM9w18M+GrGb35vXwgn0WvJNwD6I9WD3CicZxmabjrPll5vc1xe3EIMouKKdud4Fea4/Ydz2R+pbcd3H00DgH8znBcNfuUp/Ijb357Um5NXDZ6ejo02l2JW1/Xf7z6b5g==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get contact list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"contactdetails[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)(o.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,l.jsx)(o.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,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "result": [\n {\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 }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink