WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-30 11:49:45 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
177ffecb2b05dac4e7bb46affc0d8fa54bb05d85
OpenSign/assets/js/8a725248.e89d4ca1.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),n=s(11151),i=s(58219),r=(s(62316),s(51039)),t=s.n(r),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvcOTWAYsuOexEWi2aDoMi2aII6iz04RkBJY5sNRbIk5Q8Y+u+LoWRZttN8XHoJnOEMOfPezBttwfO5g2QCV1p5nnkH0wi0Qcu90OomhwQyi9xjVp9DBIZbXqBHS3FbULxASGB9zo049/oJFUQgFCSwQJ6jhQgs/iyFxRwSb0uMwPmNpBgnCiMRIsC1kTpHSGZcOnLIFlhwSLbgNyZ4eivUHCpy5SEooSyVE3PVW6/Xa6im9Tvo/N8631Bsji6zwlAhkICxeilyZClKvWJtEcxrVlfI9iXSL1SeLuHGSJEFNPo/HN207aS3r2wC1wUXEiL4RoBEcLfQCgnNpgSd/sAaP0v4eoGObgjeJ4VGMNO24L5r2Vf+Q1MZSHDUj74/PkX81Bh6mS7oqjrhd141GF4MBxeDi+EAqioCL3wwH/TMY0qEVHR+2AnB4IxWrsZiGMenvDWN2ZCUM1dmGTo3K6Xc/PEerl7mIQv913qpskhD77alDuO4iqBA5/j8WZj2oLyccl11Kf3rSdVmmsKXnrtbZE+Dhf5nmB9wIJQUCh93CD8O4/hx8Ng8/aoj8VVFMIpHp5SMdYF+IdScrVB5trJazSNmJHKHzNsN43MuFJPco/2dFI3i0Vspel8JL6E1ikcdtD6eonWjllyKnF3e3bB70sffC8nHt0LSzdPXeVJN6yLoSyPzonaqdf4Ala69RsNhVlrhN2FNdPdDMpmSXB/N+bEIE0GaFpDRrt47fgEJ9I/3kUO73C2j0kpaPN4bl/T73JjebktInjpSuj43or8chH2xS3BMaNeAHqTZosWN+IIbiF5fdlQ3kfh9v4qudwjvxL7V71a+n1PkVpAPNJZem+mQWoP8rUE1FnMVeFsO4BjX+4VwTLhwnOusLFD50Gxspi07imYpd5gzrZhfYDgk+0VvwJzBTMyaPu2xB/WgaIZY6XBWSiaFenLJgzpnk9vZTGSCS/Yfpk54nH7Y8bFarU74OAsxn4VflCmzaPTefR6MgbRuVPvPGUTg0RbudjZGuxQZNtz/4ql+cO4300fNk2wBGwYa06fjIIJcigyVw84YXH6++8ouejFEnZZ7Q8r9rzdX19/G13QrNW1N0aAX92IyUacXXHUeOpmKA3LbBvW49n0juQhDGVLaNgMzOfqAm0awoIFKJrDdEt3/WllVZP5ZoqVhnUaw5FbwlPprMq2iXXPThOXC0UHefqsdJdQKG3z43iz7MwbR84k+4eZkmpZcluQJVbRtHK7qO8/v6Y69x4lw7iMuswyNf9F32lGYu9vxPUSQNh+ORVBVsHxFH698BQk8wAMAfRnTDUEpgn0Lkqt5GbQV6ntJAXhJyHfl4ynIR/ODcNwdqU0ny0Mk6lLoLxX2bMCfNJ5fcPNX616f/DKg/SavvYmGaVVV/wOX6BvE",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/createcontact",title:"Create contact",description:"Create contact",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvcOTWAYsuOexEWi2aDoMi2aII6iz04RkBJY5sNRbIk5Q8Y+u+LoWRZttN8XHoJnOEMOfPezBttwfO5g2QCV1p5nnkH0wi0Qcu90OomhwQyi9xjVp9DBIZbXqBHS3FbULxASGB9zo049/oJFUQgFCSwQJ6jhQgs/iyFxRwSb0uMwPmNpBgnCiMRIsC1kTpHSGZcOnLIFlhwSLbgNyZ4eivUHCpy5SEooSyVE3PVW6/Xa6im9Tvo/N8631Bsji6zwlAhkICxeilyZClKvWJtEcxrVlfI9iXSL1SeLuHGSJEFNPo/HN207aS3r2wC1wUXEiL4RoBEcLfQCgnNpgSd/sAaP0v4eoGObgjeJ4VGMNO24L5r2Vf+Q1MZSHDUj74/PkX81Bh6mS7oqjrhd141GF4MBxeDi+EAqioCL3wwH/TMY0qEVHR+2AnB4IxWrsZiGMenvDWN2ZCUM1dmGTo3K6Xc/PEerl7mIQv913qpskhD77alDuO4iqBA5/j8WZj2oLyccl11Kf3rSdVmmsKXnrtbZE+Dhf5nmB9wIJQUCh93CD8O4/hx8Ng8/aoj8VVFMIpHp5SMdYF+IdScrVB5trJazSNmJHKHzNsN43MuFJPco/2dFI3i0Vspel8JL6E1ikcdtD6eonWjllyKnF3e3bB70sffC8nHt0LSzdPXeVJN6yLoSyPzonaqdf4Ala69RsNhVlrhN2FNdPdDMpmSXB/N+bEIE0GaFpDRrt47fgEJ9I/3kUO73C2j0kpaPN4bl/T73JjebktInjpSuj43or8chH2xS3BMaNeAHqTZosWN+IIbiF5fdlQ3kfh9v4qudwjvxL7V71a+n1PkVpAPNJZem+mQWoP8rUE1FnMVeFsO4BjX+4VwTLhwnOusLFD50Gxspi07imYpd5gzrZhfYDgk+0VvwJzBTMyaPu2xB/WgaIZY6XBWSiaFenLJgzpnk9vZTGSCS/Yfpk54nH7Y8bFarU74OAsxn4VflCmzaPTefR6MgbRuVPvPGUTg0RbudjZGuxQZNtz/4ql+cO4300fNk2wBGwYa06fjIIJcigyVw84YXH6++8ouejFEnZZ7Q8r9rzdX19/G13QrNW1N0aAX92IyUacXXHUeOpmKA3LbBvW49n0juQhDGVLaNgMzOfqAm0awoIFKJrDdEt3/WllVZP5ZoqVhnUaw5FbwlPprMq2iXXPThOXC0UHefqsdJdQKG3z43iz7MwbR84k+4eZkmpZcluQJVbRtHK7qO8/v6Y69x4lw7iMuswyNf9F32lGYu9vxPUSQNh+ORVBVsHxFH698BQk8wAMAfRnTDUEpgn0Lkqt5GbQV6ntJAXhJyHfl4ynIR/ODcNwdqU0ny0Mk6lLoLxX2bMCfNJ5fcPNX616f/DKg/SavvYmGaVVV/wOX6BvE",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your details",permalink:"/docs/API-docs/get-user"},next:{title:"Get contact",permalink:"/docs/API-docs/getcontact"}},g={},f=[{value:"Request",id:"request",level:2}];function N(e){const a={h2:"h2",p:"p",...(0,n.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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create contact"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/createcontact"}),"\n",(0,l.jsx)(a.p,{children:"Create contact"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{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)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.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)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to create contact"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact created successfully!"})}),(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)(s,{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)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact created successfully!"}}),(0,l.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{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)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsx)("div",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Phck1hoJ2d"}})})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 200,\n "message": "Contact created successfully!",\n "result": {\n "objectId": "Phck1hoJ2d"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(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)(s,{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)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 404,\n "message": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.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)(s,{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)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(m.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 b(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(N,{...e})}):N(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink