【顺丰快递管家】通用接口文档


3.用户批量删除接口

<h3>功能描述</h3> <ul> <li>该接口用于:批量删除用户数据。</li> </ul> <h3>接口定义</h3> <table> <thead> <tr> <th style="text-align: center;">服务名称</th> <th style="text-align: center;">批量交易</th> <th style="text-align: center;">接口类型</th> <th style="text-align: center;">接口uri(同确认接口)</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">用户批量删除接口</td> <td style="text-align: center;">支持</td> <td style="text-align: center;">接入/POST</td> <td style="text-align: center;">/public/user/v1/batchDelete</td> </tr> </tbody> </table> <h3>元素&lt;请求&gt;</h3> <ul> <li><strong>主体</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">默认值</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">companyId</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">分配客户sendAppId。</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">userNos</td> <td style="text-align: center;">String(4000)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">需删除的用户账号集合。多个时以英文逗号间隔。</td> </tr> </tbody> </table> <h3>元素&lt;响应&gt;</h3> <ul> <li><strong>主体</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">msg</td> <td style="text-align: center;">String(200)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">信息</td> <td style="text-align: left;">提示信息</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">succ</td> <td style="text-align: center;">String(10)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">状态码</td> <td style="text-align: left;">返回成功或失败信息(ok/fail)</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">List&lt;errorInfo&gt;</td> <td style="text-align: center;">是</td> <td style="text-align: center;">错误数据集合</td> <td style="text-align: left;">succ = ok时为空;succ = fail时不为空;</td> </tr> </tbody> </table> <ul> <li><strong>errorInfo 说明</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">rowNo</td> <td style="text-align: center;">Number(10)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">错误数据所在行号</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">userNo</td> <td style="text-align: center;">String(50)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">用户账号</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">cause</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">错误原因</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ &amp;quot;companyId&amp;quot;: &amp;quot;201905140011898&amp;quot;, &amp;quot;userNos&amp;quot;: &amp;quot;zhangsan,lisi01&amp;quot; }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;result&amp;quot;: null }</code></pre></li> <li>失败报文-范例1 <pre><code>{ &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot;, &amp;quot;msg&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;result&amp;quot;: [ { &amp;quot;rowNo&amp;quot;: 2, &amp;quot;userNo&amp;quot;: &amp;quot;lisi01&amp;quot;, &amp;quot;cause&amp;quot;: &amp;quot;用户账号不存在!&amp;quot; } ] }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML