WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-26 19:44:53 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
be795859cd3b929f89811236c3ecb06151c63af2
OpenSign/assets/js/7b076186.3033ed56.js
T

1 line
9.6 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),o=s(58219),n=(s(62316),s(51039)),i=s.n(n),c=(s(82723),s(9487)),r=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyLbspB0mDMOyNuiMBkuwZBgwxwho6WSxpkiWpBwbhv77cJRky3FS9MMwYF9s6fgc7+65N+3A86WDZAbvtfI89Q7mEWToUiuMF1pBAvcFsg8o0SNrQezydsq4lPrJsa2umNfMYqnXyDhLW0hudUmHtpMstF4N2TQPGkozqdUSLVOIGePMcOtFWkm+x3/vmFC5tiUnPyLmC+GC4ZKv0DHhGXK3JdtZ45wvUFhmMdU2G0IE2qANutMMEmhA7d0QgeGWl+jRUvQ7ULxESKA9fxQZRCAoesN9Ac8pubV6LTJkevEZUz/NmM73ge8dgggsfqmExQwSbyuMwPmtJDNOlEYSADdG6gwhybl0BEgLLDkkO/BbE5DeCrWECBom+hLc8HBLAqaYLIoJdxnU9ZysOqOVQ0f3TOKY/o797/LYOJoxV6UpOpdXUm6/gyjQgMqTIjdGijTwOPrsSHt36mXDA7FqiXUvGtsdPS/Fc/D+1w35bn4z51BHbZ6yS/91pUk8OR+M40H8w/34XXLxY/L23TCO478hgk0pSbfNaMY90r1eeHl4r09gTcr6wFZSE/givnidRaU9y3Wlsn+ROrRW269T8IL5uue/UFIofOyK4fEivnic7MN5exrOVK25FFnosXu9QvXfhtM37xvzp2kSDSicw1GwfXkTpMO0ssJvQ39vBtyIQXOezObUJiX6Qh9GQ5gJvoAERm0rj3aHcVADXWjX3byorIQECu+NS0Yj5/lSqOWAGzPUBpUTSyX5wg1TXY64EaP1GMhk59Id0dYwc+TYnh9uxCfcQtTF3Ue1g6lAnqENHNGcDMotGzcG1Z1YqsDlenwyvu5plLbTNNNpVaLyIa8s15Y902YL7jBjWtGADYckPx+OmTOYirwtiSF7UA/qTpfIKod5JZkUauWSBzVgs5s8F6ngkv2FCyc8zt90zD09PZ0wdhZ0PgpfVAtm0egDfBmEgda+1v7lDCLwaEt3k9+hXYsU2yy9YmoUwKO20GkzULGWXMjDMvjluRIVnhQpKoe90rz8eHvNzocxRL3i+AaXR9fT91e/313RrVReTYrGw3gYk8ho50uueoaOd/Hz5O4OLfu/3dxtE3jc+JGRXIRWD6Tu2h6dwWGTJ72lPY+g0M4TYLejwv3Tyrom8ZcKLY2CeQRrbgVfUKfMdpAJR8/ZfgW/yuabP9ptfsa+df+/GEjX4or6e81lRW8QwQq3x18g9byOujYnVxvAZZqi8T3Vk7l8NNw+XF1f3V9BBLwi4voTZhUmTPtABl707Hj0ND7Qbx29ovATpfoTbn/ew5uTVxXaEDs0sTSv6/ofvwiihg==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyLbspB0mDMOyNuiMBkuwZBgwxwho6WSxpkiWpBwbhv77cJRky3FS9MMwYF9s6fgc7+65N+3A86WDZAbvtfI89Q7mEWToUiuMF1pBAvcFsg8o0SNrQezydsq4lPrJsa2umNfMYqnXyDhLW0hudUmHtpMstF4N2TQPGkozqdUSLVOIGePMcOtFWkm+x3/vmFC5tiUnPyLmC+GC4ZKv0DHhGXK3JdtZ45wvUFhmMdU2G0IE2qANutMMEmhA7d0QgeGWl+jRUvQ7ULxESKA9fxQZRCAoesN9Ac8pubV6LTJkevEZUz/NmM73ge8dgggsfqmExQwSbyuMwPmtJDNOlEYSADdG6gwhybl0BEgLLDkkO/BbE5DeCrWECBom+hLc8HBLAqaYLIoJdxnU9ZysOqOVQ0f3TOKY/o797/LYOJoxV6UpOpdXUm6/gyjQgMqTIjdGijTwOPrsSHt36mXDA7FqiXUvGtsdPS/Fc/D+1w35bn4z51BHbZ6yS/91pUk8OR+M40H8w/34XXLxY/L23TCO478hgk0pSbfNaMY90r1eeHl4r09gTcr6wFZSE/givnidRaU9y3Wlsn+ROrRW269T8IL5uue/UFIofOyK4fEivnic7MN5exrOVK25FFnosXu9QvXfhtM37xvzp2kSDSicw1GwfXkTpMO0ssJvQ39vBtyIQXOezObUJiX6Qh9GQ5gJvoAERm0rj3aHcVADXWjX3byorIQECu+NS0Yj5/lSqOWAGzPUBpUTSyX5wg1TXY64EaP1GMhk59Id0dYwc+TYnh9uxCfcQtTF3Ue1g6lAnqENHNGcDMotGzcG1Z1YqsDlenwyvu5plLbTNNNpVaLyIa8s15Y902YL7jBjWtGADYckPx+OmTOYirwtiSF7UA/qTpfIKod5JZkUauWSBzVgs5s8F6ngkv2FCyc8zt90zD09PZ0wdhZ0PgpfVAtm0egDfBmEgda+1v7lDCLwaEt3k9+hXYsU2yy9YmoUwKO20GkzULGWXMjDMvjluRIVnhQpKoe90rz8eHvNzocxRL3i+AaXR9fT91e/313RrVReTYrGw3gYk8ho50uueoaOd/Hz5O4OLfu/3dxtE3jc+JGRXIRWD6Tu2h6dwWGTJ72lPY+g0M4TYLejwv3Tyrom8ZcKLY2CeQRrbgVfUKfMdpAJR8/ZfgW/yuabP9ptfsa+df+/GEjX4or6e81lRW8QwQq3x18g9byOujYnVxvAZZqi8T3Vk7l8NNw+XF1f3V9BBLwi4voTZhUmTPtABl707Hj0ND7Qbx29ovATpfoTbn/ew5uTVxXaEDs0sTSv6/ofvwiihg==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"}},j={},g=[{value:"Request",id:"request",level:2}];function v(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:"Delete Contact"})}),"\n",(0,t.jsx)(i(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\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)(r.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(o.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact deleted successfully!"})}),(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",example:"Bxh2aspHp3"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"deletedAt",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": "Bxh2aspHp3",\n "deletedAt": "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)(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)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink