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


2.组织批量修改接口

<h3>功能描述</h3> <ul> <li>该接口用于:批量修改组织数据。</li> </ul> <pre><code>注: 1.判重条件:组织编码不为空时不允许重复,为空时不做判重校验,同一父节点下组织名不能重复; 2.此接口不支持修改月结卡号;</code></pre> <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/organization/v1/batchUpdate</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;">organizationList</td> <td style="text-align: center;">List&lt;organizationInfo&gt;</td> <td style="text-align: center;">是</td> <td style="text-align: center;">组织数据集合。</td> </tr> </tbody> </table> <ul> <li><strong>organizationInfo 说明</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;">organizationName</td> <td style="text-align: center;">String(64)</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;">organizationLevel</td> <td style="text-align: center;">Number(2)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">新的组织层级。组织所在的层级,如:根组织是1,二级组织是2。注:根组织为系统自动生成,无法导入。</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">organizationCode</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">原有组织编码。不能修改。</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">parentCode</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">新的父组织编码。新的上级组织的组织编码。根组织组织编码请向顺丰接口人获取。</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">custGlobalUse</td> <td style="text-align: center;">Number(2)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">0</td> <td style="text-align: left;">月结卡号是否全组织使用(0/其它:否,1:是,默认是0)</td> </tr> <tr> <td style="text-align: center;">6</td> <td style="text-align: center;">contactNo</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">新的组织负责人工号。</td> </tr> <tr> <td style="text-align: center;">7</td> <td style="text-align: center;">contactName</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">新的组织负责人姓名。</td> </tr> <tr> <td style="text-align: center;">8</td> <td style="text-align: center;">contactPhone</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">新的组织负责人电话。</td> </tr> <tr> <td style="text-align: center;">9</td> <td style="text-align: center;">remark</td> <td style="text-align: center;">String(128)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">新的备注。</td> </tr> <tr> <td style="text-align: center;">10</td> <td style="text-align: center;">senderWhether</td> <td style="text-align: center;">Number(1)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">新的审批规则:寄件个数限制。需要使用时需传值,0-否,1-是。默认为否。</td> </tr> <tr> <td style="text-align: center;">11</td> <td style="text-align: center;">senderNumber</td> <td style="text-align: center;">Number(10)</td> <td style="text-align: center;">条件</td> <td style="text-align: center;">新的寄件个数限制数量。当xx传1时必填,输入正整数,如:10000,超过限制数量时,寄件会自动触发审批流程。</td> </tr> <tr> <td style="text-align: center;">12</td> <td style="text-align: center;">freightWhether</td> <td style="text-align: center;">Number(1)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">新的审批规则:寄件运费限制。需要使用时需传值,0-否,1-是。默认为否。</td> </tr> <tr> <td style="text-align: center;">13</td> <td style="text-align: center;">freight</td> <td style="text-align: center;">Number(10,2)</td> <td style="text-align: center;">条件</td> <td style="text-align: center;">新的寄件运费限制金额。当xx传1时必填,如:10000.01,超过限制金额时,寄件会自动触发审批流程。</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;">organizationName</td> <td style="text-align: center;">String(64)</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;">organizationCode</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">新的组织编码</td> </tr> <tr> <td style="text-align: center;">4</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;organizationList&amp;quot;: [ { &amp;quot;organizationName&amp;quot;: &amp;quot;IT部&amp;quot;, &amp;quot;organizationLevel&amp;quot;: 2, &amp;quot;organizationCode&amp;quot;: &amp;quot;IT0001&amp;quot;, &amp;quot;parentCode&amp;quot;: &amp;quot;SFKDGJ&amp;quot;, &amp;quot;custGlobalUse&amp;quot;,&amp;quot;0&amp;quot;, &amp;quot;contactNo&amp;quot;: &amp;quot;123465&amp;quot;, &amp;quot;contactName&amp;quot;: &amp;quot;张三&amp;quot;, &amp;quot;contactPhone&amp;quot;: &amp;quot;15012345678&amp;quot;, &amp;quot;remark&amp;quot;: &amp;quot;这是一个相当NB的部门&amp;quot;, &amp;quot;senderWhether&amp;quot;: 1, &amp;quot;senderNumber&amp;quot;: 100, &amp;quot;freightWhether&amp;quot;: 1, &amp;quot;freight&amp;quot;: 1000 }, { &amp;quot;organizationName&amp;quot;: &amp;quot;行政部&amp;quot;, &amp;quot;organizationLevel&amp;quot;: 2, &amp;quot;organizationCode&amp;quot;: &amp;quot;XZ0001&amp;quot;, &amp;quot;parentCode&amp;quot;: &amp;quot;SFKDGJ&amp;quot;, &amp;quot;custGlobalUse&amp;quot;,&amp;quot;1&amp;quot;, &amp;quot;contactNo&amp;quot;: &amp;quot;654987&amp;quot;, &amp;quot;contactName&amp;quot;: &amp;quot;赵四&amp;quot;, &amp;quot;contactPhone&amp;quot;: &amp;quot;15012345678&amp;quot;, &amp;quot;remark&amp;quot;: &amp;quot;尼古拉斯家族&amp;quot;, &amp;quot;senderWhether&amp;quot;: 0, &amp;quot;freightWhether&amp;quot;: 0 } ] }</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;organizationName&amp;quot;: &amp;quot;行政部&amp;quot;, &amp;quot;organizationCode&amp;quot;: &amp;quot;XZ0001&amp;quot;, &amp;quot;cause&amp;quot;: &amp;quot;无此组织编码对应数据!&amp;quot; }, { &amp;quot;rowNo&amp;quot;: 4, &amp;quot;organizationName&amp;quot;: &amp;quot;人资部&amp;quot;, &amp;quot;organizationCode&amp;quot;: &amp;quot;RZ0001&amp;quot;, &amp;quot;cause&amp;quot;: &amp;quot;组织负责人电话格式错误!&amp;quot; } ] }</code></pre></li> <li>失败报文-范例2 <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;未接收到组织数据&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML