WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-27 20:14:53 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
d8482872609d28cd99bb4287eebd62b0bf358ef8
OpenSign/assets/js/05632a52.48542eac.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:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),c=(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:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLSkJqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2edQlxAw55N23p7ZmWfmNoJkGUR6KV5bQzKnIGaJKDDkXjlS1ohUXFQIb5Ggl4DTD2cgtbbLAGvbAFnwSF7hAqFAkkoHkJltCCQEh7maqxzyTnckEmEdesmmzwqRihKpPxOJcNLLGgk9R7QRRtYoUtGfX6lCJEJxRE5SJe6GabNrzOmsADuHW5MePzfKYyFS8g0mItBas9GgaqdRJAJXTtsCRTqXOrBAXmEtRboRtHZRkrwypUjE3Ppa0vANrmS0kgr3yzSr8uPKZaJtZ+w2OGsCBjZ0PJnwv/1wQ5PnGMK80bDLiEgiWDTE8tI5rfJ4ML4OrLS5H12HmnPn2QypzuU2GY/GUU2zanV87USb9Pl/nIFri5AhsjrWUun/oZ8hvupfjHJbsylXWfPoUE6mz6fH8Y9N5B4lYXFKh8zcKh1Pjp8fTSdHk+8vpi/Tkx/SFy9Hk8nkT5GIVR3R9FVZSIooSZEePjeu+AZ+2rtifcX3DThU2PZC27LWyaFaPLc1UqVMCUs0BEtvTZmA0ygDAvk1yFIqA1oS+idfr0jRe+u/nKbHRdYOYCujlcGrbSNenUwmV9NdEk7uJ2FLb8YSzG1jim+L9ID7L8M5uTrewXlxH86ZWUitisjWF/YGzbeFM3RPnfv7Ras6oXgu9sAO33cgA+aNV7SOk2F1JJ066s7TyxkzLteJ7SdKHCVUiVSM++ofb26nSCvYml9sx0zjtUhFReRCOh5L50bWoQmqNFpmgSloLJ0aL5hG7koHkqUy5dEjtaQpMrt6WGN2i/ec76RL+x7qXfKlU7/iWmzpek+qn5cVygJ9vABl5jYq96l+79Ccq9LEi1pM703Vj6hzWyNPeaoQtuL//PV31Chs3tRoKNbRE3jfeHB2iZ7HmjQFzDWuVKbxwNIQUNYaQ9BrUIaw9JIQClUqkho4K9z1uXQyU1px5bGYZW0Pg+INI/hYIVXo+eg7jyChwAVqLljQ1t6wHbIgG7J19NHHDEvrb+YcUgISsiYogyFAQNyqoKmkyRG2d5GA9SANoCH0zquAIFXNwnPrAedzlSs2zLXmuZlraWSJ7CwBjpuz4LxdqAIDeJs1gSBY3UQg7LFGpA6iQSzCCH5WC+yA88uO3rGAsmETCeS2QOi7jmGYAjIMBI7dqxyj0UDSE2hcoI/VGm9y3mgNzjIdKKl5aRreLRsiL03gAdsFtL2aXfqct7zBRB+FXI/gk/lkmLChCcgFoJW5CekncwSXuzL7iFlQhLOn215YLpf3+uDZvs5bRVWTgUdnb/XK+DJ2zVB99/BMJILQ1+H9/Bz9QuXYN+ADPsdReNyTJA9MJrpuheEee3VXgQlLqxxNwAGlnb798A4W8Hw0Ecmg6/9DwON3Z6/f/Hb+hu0yN3X9Nx1NRpO4AtlAtTQDV4Od/G7bbm6Z/muv7z3rEK5o7LRUkbgj0E1Pupfidv1OB8v7LBGVDcQCm00mA/7hddvy688Neib2WSIW0iuZMTVdbkShAn8vdsv5gyCf/t7v+c/g8O+Ag2FvGdQwfS6kbvhJJOIG1/u/O9pZm2xZlAPrBE7zHB0NVO/N1L3B9PbNhUiEbDhHQ/a+iezdf2HrB8Pap/UuAP7k6XJQ4Ue+6F9x/dNOvDt5UKHHt5XmFM3atv0XV/Dhaw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=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/dIE5HtxnJSKUmLSkJqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2edQlxAw55N23p7ZmWfmNoJkGUR6KV5bQzKnIGaJKDDkXjlS1ohUXFQIb5Ggl4DTD2cgtbbLAGvbAFnwSF7hAqFAkkoHkJltCCQEh7maqxzyTnckEmEdesmmzwqRihKpPxOJcNLLGgk9R7QRRtYoUtGfX6lCJEJxRE5SJe6GabNrzOmsADuHW5MePzfKYyFS8g0mItBas9GgaqdRJAJXTtsCRTqXOrBAXmEtRboRtHZRkrwypUjE3Ppa0vANrmS0kgr3yzSr8uPKZaJtZ+w2OGsCBjZ0PJnwv/1wQ5PnGMK80bDLiEgiWDTE8tI5rfJ4ML4OrLS5H12HmnPn2QypzuU2GY/GUU2zanV87USb9Pl/nIFri5AhsjrWUun/oZ8hvupfjHJbsylXWfPoUE6mz6fH8Y9N5B4lYXFKh8zcKh1Pjp8fTSdHk+8vpi/Tkx/SFy9Hk8nkT5GIVR3R9FVZSIooSZEePjeu+AZ+2rtifcX3DThU2PZC27LWyaFaPLc1UqVMCUs0BEtvTZmA0ygDAvk1yFIqA1oS+idfr0jRe+u/nKbHRdYOYCujlcGrbSNenUwmV9NdEk7uJ2FLb8YSzG1jim+L9ID7L8M5uTrewXlxH86ZWUitisjWF/YGzbeFM3RPnfv7Ras6oXgu9sAO33cgA+aNV7SOk2F1JJ066s7TyxkzLteJ7SdKHCVUiVSM++ofb26nSCvYml9sx0zjtUhFReRCOh5L50bWoQmqNFpmgSloLJ0aL5hG7koHkqUy5dEjtaQpMrt6WGN2i/ec76RL+x7qXfKlU7/iWmzpek+qn5cVygJ9vABl5jYq96l+79Ccq9LEi1pM703Vj6hzWyNPeaoQtuL//PV31Chs3tRoKNbRE3jfeHB2iZ7HmjQFzDWuVKbxwNIQUNYaQ9BrUIaw9JIQClUqkho4K9z1uXQyU1px5bGYZW0Pg+INI/hYIVXo+eg7jyChwAVqLljQ1t6wHbIgG7J19NHHDEvrb+YcUgISsiYogyFAQNyqoKmkyRG2d5GA9SANoCH0zquAIFXNwnPrAedzlSs2zLXmuZlraWSJ7CwBjpuz4LxdqAIDeJs1gSBY3UQg7LFGpA6iQSzCCH5WC+yA88uO3rGAsmETCeS2QOi7jmGYAjIMBI7dqxyj0UDSE2hcoI/VGm9y3mgNzjIdKKl5aRreLRsiL03gAdsFtL2aXfqct7zBRB+FXI/gk/lkmLChCcgFoJW5CekncwSXuzL7iFlQhLOn215YLpf3+uDZvs5bRVWTgUdnb/XK+DJ2zVB99/BMJILQ1+H9/Bz9QuXYN+ADPsdReNyTJA9MJrpuheEee3VXgQlLqxxNwAGlnb798A4W8Hw0Ecmg6/9DwON3Z6/f/Hb+hu0yN3X9Nx1NRpO4AtlAtTQDV4Od/G7bbm6Z/muv7z3rEK5o7LRUkbgj0E1Pupfidv1OB8v7LBGVDcQCm00mA/7hddvy688Neib2WSIW0iuZMTVdbkShAn8vdsv5gyCf/t7v+c/g8O+Ag2FvGdQwfS6kbvhJJOIG1/u/O9pZm2xZlAPrBE7zHB0NVO/N1L3B9PbNhUiEbDhHQ/a+iezdf2HrB8Pap/UuAP7k6XJQ4Ue+6F9x/dNOvDt5UKHHt5XmFM3atv0XV/Dhaw==",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={},b=[{value:"Request",id:"request",level:2}];function f(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)(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)(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)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink