E9文书定接口说明

E9档案对外接口


按件/卷内-接收接口

<p>[TOC]</p> <h4>简要描述</h4> <ul> <li>供第三方推送档案数据,实现以件(卷内)的方式推送数据到接收库或者预归档库.主要是针对rest接口使用的详细说明.</li> </ul> <h4>Webservice接口</h4> <ul> <li> <p>URL <code>/services/ArchiveService?wsdl</code></p> </li> <li>方法 <code>archiveReceive</code></li> </ul> <h4>Restful接口</h4> <ul> <li> <p>URL <code>/api/archive/base/recieveData</code></p> </li> <li>方式 <code>POST</code></li> </ul> <h4>请求头(Header)</h4> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">参数类型</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;"><a href="https://www.showdoc.com.cn/2408347292986702/10705194217472618">token</a></td> <td style="text-align: left;">rest需认证: 是 &lt;br&gt; Webservice: 否 &lt;br&gt;rest免登陆: 否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">认证token值 &lt;br&gt;postman工具可以传cookie</td> </tr> <tr> <td style="text-align: left;">appid</td> <td style="text-align: left;">同上</td> <td style="text-align: left;">string</td> <td style="text-align: left;">许可证号码</td> </tr> <tr> <td style="text-align: left;">userid</td> <td style="text-align: left;">同上</td> <td style="text-align: left;">string</td> <td style="text-align: left;">通过第一步注册许可时返回spk公钥&lt;br&gt;对userid进行加密生成的密文</td> </tr> <tr> <td style="text-align: left;">Content-Type</td> <td style="text-align: left;">body传参: 是&lt;br&gt;Query传参: 否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">json格式:application/json &lt;br&gt; xml格式:application/xml</td> </tr> </tbody> </table> <h4>Query参数 [过时] [与Body参数二选一]</h4> <table> <thead> <tr> <th>参数名</th> <th>必选</th> <th>参数类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>xml</td> <td>是</td> <td>string</td> <td>xml/json字符串 [[示例](<a href="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=d1b924b7b91e60fcc4a5a162997e68c8&amp;file=file.png">https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=d1b924b7b91e60fcc4a5a162997e68c8&amp;file=file.png</a> &quot;示例&quot;)]</td> </tr> </tbody> </table> <h4>Body参数 [推荐] [与Query参数二选一]</h4> <ul> <li>xml/json字符串, 参考下面的报文说明 [[示例](<a href="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=a58c6d5ddfade63c2401b2b21fbb713b&amp;file=file.png">https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=a58c6d5ddfade63c2401b2b21fbb713b&amp;file=file.png</a> &quot;示例&quot;)]</li> </ul> <h4>请求报文说明</h4> <ul> <li><a href="https://www.showdoc.com.cn/2408347292986702/10708991673231672">参数说明</a></li> <li><a href="https://www.showdoc.com.cn/2408347292986702/10708449002583230">接收库</a></li> <li><a href="https://www.showdoc.com.cn/2408347292986702/10708450185041215">预归档</a></li> </ul> <h4>postman示例</h4> <ul> <li> <p>接收库 <img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=2ccfd50632bfcd59b6cff4316a724199&amp;amp;file=file.png" alt="" /></p> </li> <li>预归档 <img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=c9c376090dbac4527bdf556b5b1c07dc&amp;amp;file=file.png" alt="" /></li> </ul> <h4>返回示例</h4> <p>接收库</p> <pre><code>{   &amp;quot;result&amp;quot;: [         {             &amp;quot;formBizId&amp;quot;: &amp;quot;59517000145&amp;quot;,             &amp;quot;messsage&amp;quot;: &amp;quot;xml接收成功!&amp;quot;,             &amp;quot;status&amp;quot;: true,             &amp;quot;uniqueV&amp;quot;: &amp;quot;2dcbd2d3-d25e-4e91-8558-f0e0738adddb&amp;quot;         },         {             &amp;quot;formBizId&amp;quot;: &amp;quot;59517000144&amp;quot;,             &amp;quot;messsage&amp;quot;: &amp;quot;更新成功!&amp;quot;,             &amp;quot;status&amp;quot;: true,             &amp;quot;uniqueV&amp;quot;: &amp;quot;2dcbd2d3-d25e-4e91-8558-f0e0738addda&amp;quot;         }     ],     &amp;quot;runStatus&amp;quot;: true }</code></pre> <p>预归档库</p> <pre><code> {     &amp;quot;result&amp;quot;: [         {             &amp;quot;docFormBizId&amp;quot;: &amp;quot;54581000524&amp;quot;,             &amp;quot;formBizId&amp;quot;: &amp;quot;-1&amp;quot;,             &amp;quot;messsage&amp;quot;: &amp;quot;xml接收成功!&amp;quot;,             &amp;quot;status&amp;quot;: true,             &amp;quot;uniqueV&amp;quot;: &amp;quot;2dcbd2d3-d25e-4e91-8558-f0e0738addda&amp;quot;         },     {             &amp;quot;docFormBizId&amp;quot;: &amp;quot;54581000523&amp;quot;,             &amp;quot;formBizId&amp;quot;: &amp;quot;-1&amp;quot;,             &amp;quot;messsage&amp;quot;: &amp;quot;更新成功!&amp;quot;,             &amp;quot;status&amp;quot;: true,             &amp;quot;uniqueV&amp;quot;: &amp;quot;2dcbd2d3-d25e-4e91-8558-f0e0738adddb&amp;quot;         }     ],     &amp;quot;runStatus&amp;quot;: true }</code></pre> <h4>返回参数</h4> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">formBizId</td> <td style="text-align: left;">string</td> <td>接收库档案条目数据ID</td> </tr> <tr> <td style="text-align: left;">docFormBizId</td> <td style="text-align: left;">string</td> <td>预归档库电子原文ID</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">boolean</td> <td>接口执行状态</td> </tr> <tr> <td style="text-align: left;">messsage</td> <td style="text-align: left;">string</td> <td>提示信息</td> </tr> <tr> <td style="text-align: left;">uniqueV</td> <td style="text-align: left;">string</td> <td>业务请求传入的唯一值</td> </tr> </tbody> </table> <h4>备注</h4> <ul> <li>返回错误代码请看下图描述</li> </ul> <pre><code> {     &amp;quot;result&amp;quot;: [         {             &amp;quot;docFormBizId&amp;quot;: &amp;quot;&amp;quot;,             &amp;quot;formBizId&amp;quot;: &amp;quot;&amp;quot;,          &amp;quot;messsage&amp;quot;: &amp;quot;元数据表不存在!&amp;quot;,          &amp;quot;status&amp;quot;: false,             &amp;quot;uniqueV&amp;quot;: &amp;quot;2dcbd2d3-d25e-4e91-8558-f0e0738adddb&amp;quot;         }     ],     &amp;quot;runStatus&amp;quot;: true } </code></pre>

页面列表

ITEM_HTML