WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-24 08:32:34 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
177ffecb2b05dac4e7bb46affc0d8fa54bb05d85
OpenSign/assets/js/a2bc1463.f4361f8a.js
T

1 line
10 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:()=>f,contentTitle:()=>u,default:()=>g,frontMatter:()=>x,metadata:()=>j,toc:()=>b});var l=a(85893),i=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),c=(a(82723),a(9487)),m=a(41429),d=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:"eJy9Vm1v2zYQ/ivafWoAxZKd9IswDM2CIAhaNEGdYR9sI6Cks8WYIlmS8gsM/ffhKMmW7WZdhmGAYcvHO/LuuececQeOLSwkE7hV0rHMWZiFkKPNDNeOKwkJQAhKo2H09yGHBLLGVXDrIATNDCvRoaFtdiBZiZDA5pJpfunUEiWEwGmfAlmOBkIw+L3iBnNInKkwBOu2gmIsL7VACAE3WqgcIZkzYckhK7BkkOzAbbX3dIbLBdTkynxQQjlKyxdysNlsNlDPmnPQut9VvqVYShulo0emteCZryh6tVTl7vwQlb5i5is0VL/jaGlV8JK7npusytSXNVemZK5v2Sc3jOsQ7JLrd8bFdR3CphQU1gJLqKdUUR2C404c22oKMGi1krZJdxTH9HPcUltlGVo7r0Swby2E/xVCme/deaH7skZx3KRZiT6SzBi2JbY4LO3Pj2nMxMhTXvQw3VsORNHFMC02o1dNEH71qL5vg1eFQYpI4Xcl4+JfxKeIn1rDIFMlbfVUKPnuVK6HV8OR/8A5Vdo5zdExLmyfMKcrdW+NS8ElvnQkehnF8ct1y6zr+OM5mR7kigmeBzdPD8EzDfwv/yOVruOPdQglWssWP0TvgFU/T9fkeY4Zb5wa4TpCpW9v0LCYVYa7rde9vuAlkxnpT4muUCSYWrVK6QpIIDrWT4tm1YlnZQQJpXPaJlHEtB50qiZYaokpEdM8Wg29vnXnjwnMBq+jLA6DpflnpMn6qThTWdSjbwfpvOsA3EvfMO7EjMaYy7nyZ7VIPWqUY76QHufVEE5fJ88FtwG3fjlXWVWidJ4cwVyZ4CQ6SJnFPFAycAX6RbJfDYaB1ZjxecurQTCVUzlWJQaVRZI1weXSJlN5GUwe53OecSaCPzG13OHsQwfwer0+A/jCx9xzV1RpYFCrg/vCG30X+lH7PxcQgkNT2sf5GM2KZ9g2842jIu8ctdPCMj8t2ChKZ/p0GkSkFDxDabFH25v7py/B1SCGsMehf5By9OXh9u7r+I52JRY2LRoO4kFMJiJuyWTvoHt0QZta0BL4qL291yxdHFoCOty4SAvG/Uz5DHftOEyOrhOzEAoalmQCux31/g8j6prM3ys0NGmzEFbMcJYS2SazOuyoS/OTc0sL+f7m8GZuH761l5CL4K00l7g9m5UVExV5Qh3uWofbZs/LZ9rj4HGmeoeImyxD7f7Wt68eT4/jZwghba8xpZdEMGxNVym2hgSmMG1uabSD1wFv34FgclF5YYRmX5pvVhHufXFYenFoHwjHbklue1keI9GUQt9U2A8DfqVZ/Yzb3/buzcqbAfsbYuNNbZjVdf0XaweeNA==",sidebar_class_name:"post 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:"eJy9Vm1v2zYQ/ivafWoAxZKd9IswDM2CIAhaNEGdYR9sI6Cks8WYIlmS8gsM/ffhKMmW7WZdhmGAYcvHO/LuuececQeOLSwkE7hV0rHMWZiFkKPNDNeOKwkJQAhKo2H09yGHBLLGVXDrIATNDCvRoaFtdiBZiZDA5pJpfunUEiWEwGmfAlmOBkIw+L3iBnNInKkwBOu2gmIsL7VACAE3WqgcIZkzYckhK7BkkOzAbbX3dIbLBdTkynxQQjlKyxdysNlsNlDPmnPQut9VvqVYShulo0emteCZryh6tVTl7vwQlb5i5is0VL/jaGlV8JK7npusytSXNVemZK5v2Sc3jOsQ7JLrd8bFdR3CphQU1gJLqKdUUR2C404c22oKMGi1krZJdxTH9HPcUltlGVo7r0Swby2E/xVCme/deaH7skZx3KRZiT6SzBi2JbY4LO3Pj2nMxMhTXvQw3VsORNHFMC02o1dNEH71qL5vg1eFQYpI4Xcl4+JfxKeIn1rDIFMlbfVUKPnuVK6HV8OR/8A5Vdo5zdExLmyfMKcrdW+NS8ElvnQkehnF8ct1y6zr+OM5mR7kigmeBzdPD8EzDfwv/yOVruOPdQglWssWP0TvgFU/T9fkeY4Zb5wa4TpCpW9v0LCYVYa7rde9vuAlkxnpT4muUCSYWrVK6QpIIDrWT4tm1YlnZQQJpXPaJlHEtB50qiZYaokpEdM8Wg29vnXnjwnMBq+jLA6DpflnpMn6qThTWdSjbwfpvOsA3EvfMO7EjMaYy7nyZ7VIPWqUY76QHufVEE5fJ88FtwG3fjlXWVWidJ4cwVyZ4CQ6SJnFPFAycAX6RbJfDYaB1ZjxecurQTCVUzlWJQaVRZI1weXSJlN5GUwe53OecSaCPzG13OHsQwfwer0+A/jCx9xzV1RpYFCrg/vCG30X+lH7PxcQgkNT2sf5GM2KZ9g2842jIu8ctdPCMj8t2ChKZ/p0GkSkFDxDabFH25v7py/B1SCGsMehf5By9OXh9u7r+I52JRY2LRoO4kFMJiJuyWTvoHt0QZta0BL4qL291yxdHFoCOty4SAvG/Uz5DHftOEyOrhOzEAoalmQCux31/g8j6prM3ys0NGmzEFbMcJYS2SazOuyoS/OTc0sL+f7m8GZuH761l5CL4K00l7g9m5UVExV5Qh3uWofbZs/LZ9rj4HGmeoeImyxD7f7Wt68eT4/jZwghba8xpZdEMGxNVym2hgSmMG1uabSD1wFv34FgclF5YYRmX5pvVhHufXFYenFoHwjHbklue1keI9GUQt9U2A8DfqVZ/Yzb3/buzcqbAfsbYuNNbZjVdf0XaweeNA==",sidebar_class_name:"post 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"}},f={},b=[{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:"post",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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.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)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.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)(c.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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(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)("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)(d.Z,{responseExample:'{\n "code": 200,\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\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)(c.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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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)(d.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(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