WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 01:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
fda95286f00a9425ce8ecacff55c4be1156769a8
OpenSign/assets/js/05632a52.a139a053.js
T

1 line
9.9 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:()=>j,contentTitle:()=>x,default:()=>I,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),c=s.n(i),r=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={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:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaWZtIu3u7K8fG6L+XWUm2HCelKceBsa2ZeeZt5xntFhxfWohv4ZOSjqfOwiKADG1qhHZCSYjhpkB2gY51Fuzs+pLxslRPlm1UzZxiBp0RuEKWoeOitIwnqnaMM6sxFblIWdpixxCA0mg4ub7MIIYluk4HAWhueIUODWW0BckrhBg6/b3IIABBGWnuCniepkoeMHWXGVM527s0+K0WBjOInakxAOs2JTm1otIlQgC41qXKEOKcl5YM0gIrDvEW3EZ7S2eEXEIAuTIVd0MJrrn3EoP+fZIU6bTQCTTNgsJaraRFS46mUUQ/h+naOk3R2rwu2a4jEPhiUTqy51qXIvWK8MESaHucXVs19c6QGyfakH0z3lxHMUmK9fRBQxPAV9//tzl4UMgSRIKfV1yU/wOfIH7sBONUVeTqulDyzanMJqeTqf+Qi9Qgd5iduZfc7EHTaHo6mkSj6OebyYd49kv8/sM4iqK/IYB15avppjLjzlfphCuHz7XOfkCc5rlZN/EdAYeAngtNQ6hZNDuexZ7ZUjmWq1pmP32/SURjlPn3XrwQvhkUIGQpJN73lLqfRbP76a6c98flXMoVL0XmF9WNekT5Y8sZhndt+OPzEq2R18NBsUN5W6TFtDbCbfxSXI+4FqNWH98uaNlU6ArVLVO/RV0BMYTdwYfb/QJtgLyZVb9ha1NCDIVz2sZhaB1fCrkcca3HSqO0YilLnlhiYci1CFcToHh9PnPqWduWg6x2zeFafMYNBH3RQ6tulRfIMzS+QULmyoO7VlxplHOxlL6Rq8nRwr8phGXCenWm0rpC6fyhslwZ9gzNEm4xY0oyV6BXkvx0PNm9ozx0zO7knZyrClltkZZzKeSjje/kiN1e5blIBS/ZX5hY4XDxru/c09PTUcdOPOZCuKJOmEGt9uZLL/RtHaJ2DycQgENT2at8jmYlUuxO6ZVQoTcOuyknstOktuu3F318DqKpK0WK0uJgLs8urr+w03EEwWA4/kPK4ZfLT+df5+fklcarPaLJOBpHJNLKuorLQSC6Uexf0wcnu92T9XtfPrrBdLh2oS658NzzhW473tzCPqt4cPVYBFAo68hgu6Vh+tOUTUPibzUa4uYigBU3gic0vbdbyISl/9nuavFqke/+6G4pJ+zlW8yLafckk8SwFS9reoIAHnFzeGtqFk3QE40Saw3O0hS1G0CP1uLBbrk4v4EAeE09GhL80RO8+0PeX0zrkPltAvTdBK8AfqWD/oyb33bmreZVQFdfb00tWjRN8w/aK65e",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={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:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaWZtIu3u7K8fG6L+XWUm2HCelKceBsa2ZeeZt5xntFhxfWohv4ZOSjqfOwiKADG1qhHZCSYjhpkB2gY51Fuzs+pLxslRPlm1UzZxiBp0RuEKWoeOitIwnqnaMM6sxFblIWdpixxCA0mg4ub7MIIYluk4HAWhueIUODWW0BckrhBg6/b3IIABBGWnuCniepkoeMHWXGVM527s0+K0WBjOInakxAOs2JTm1otIlQgC41qXKEOKcl5YM0gIrDvEW3EZ7S2eEXEIAuTIVd0MJrrn3EoP+fZIU6bTQCTTNgsJaraRFS46mUUQ/h+naOk3R2rwu2a4jEPhiUTqy51qXIvWK8MESaHucXVs19c6QGyfakH0z3lxHMUmK9fRBQxPAV9//tzl4UMgSRIKfV1yU/wOfIH7sBONUVeTqulDyzanMJqeTqf+Qi9Qgd5iduZfc7EHTaHo6mkSj6OebyYd49kv8/sM4iqK/IYB15avppjLjzlfphCuHz7XOfkCc5rlZN/EdAYeAngtNQ6hZNDuexZ7ZUjmWq1pmP32/SURjlPn3XrwQvhkUIGQpJN73lLqfRbP76a6c98flXMoVL0XmF9WNekT5Y8sZhndt+OPzEq2R18NBsUN5W6TFtDbCbfxSXI+4FqNWH98uaNlU6ArVLVO/RV0BMYTdwYfb/QJtgLyZVb9ha1NCDIVz2sZhaB1fCrkcca3HSqO0YilLnlhiYci1CFcToHh9PnPqWduWg6x2zeFafMYNBH3RQ6tulRfIMzS+QULmyoO7VlxplHOxlL6Rq8nRwr8phGXCenWm0rpC6fyhslwZ9gzNEm4xY0oyV6BXkvx0PNm9ozx0zO7knZyrClltkZZzKeSjje/kiN1e5blIBS/ZX5hY4XDxru/c09PTUcdOPOZCuKJOmEGt9uZLL/RtHaJ2DycQgENT2at8jmYlUuxO6ZVQoTcOuyknstOktuu3F318DqKpK0WK0uJgLs8urr+w03EEwWA4/kPK4ZfLT+df5+fklcarPaLJOBpHJNLKuorLQSC6Uexf0wcnu92T9XtfPrrBdLh2oS658NzzhW473tzCPqt4cPVYBFAo68hgu6Vh+tOUTUPibzUa4uYigBU3gic0vbdbyISl/9nuavFqke/+6G4pJ+zlW8yLafckk8SwFS9reoIAHnFzeGtqFk3QE40Saw3O0hS1G0CP1uLBbrk4v4EAeE09GhL80RO8+0PeX0zrkPltAvTdBK8AfqWD/oyb33bmreZVQFdfb00tWjRN8w/aK65e",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"}},j={},g=[{value:"Request",id:"request",level:2}];function b(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)(c(),{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)(n.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)(r.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:"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)(r.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)(r.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 I(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink