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


1.地址拆分接口

<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/gis/v1/addressComplete</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;">公司ID</td> <td style="text-align: left;">分配客户sendAppId。</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">province</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;">3</td> <td style="text-align: center;">city</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;">4</td> <td style="text-align: center;">address</td> <td style="text-align: center;">String(1000)</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;">level</td> <td style="text-align: center;">Number(1)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">省市区级别</td> <td style="text-align: left;">分别表示:<br>Level=1,表示只解析出省,<br>Level=2,表示能够解析到市,<br>Level=3,表示能够解析到区/县,<br>Level=4,表示能够解析到乡镇/街道;</td> </tr> <tr> <td style="text-align: center;">6</td> <td style="text-align: center;">opt</td> <td style="text-align: center;">String(1000)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">默认是空<br>按业务逻辑综合调用;<br>cpp-纯文本和地理编码的调用<br>efs-电子围栏的调用</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;">Object</td> <td style="text-align: center;">是</td> <td style="text-align: center;">错误详细信息</td> </tr> </tbody> </table> <ul> <li><strong>result 说明</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;">address</td> <td style="text-align: center;">String(1000)</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;">province</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;">3</td> <td style="text-align: center;">city</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;">4</td> <td style="text-align: center;">county</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;">5</td> <td style="text-align: center;">town</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;">6</td> <td style="text-align: center;">adcode</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;">citycode</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;">detailaddr</td> <td style="text-align: center;">String(1000)</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;">alladdress</td> <td style="text-align: center;">String(1000)</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;">errMsg</td> <td style="text-align: center;">String(1000)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">报错信息</td> <td style="text-align: left;">succ为fail时,有值,否则,为null</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ "companyId":"201905140011898", "address":"北京市顺义区南法信镇顺捷大厦" }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ "result": { "address": "北京市顺义区南法信镇顺捷大厦", "province": "北京市", "city": "北京市", "county": "顺义区", "town": "南法信地区", "adcode": "110113", "citycode": "010", "detailaddr": "顺捷大厦", "alladdress": "北京市北京市顺义区南法信地区顺捷大厦", "errMsg": null }, "succ": "ok", "msg": "地址补全成功" }</code></pre></li> <li>失败报文-范例1 <pre><code>{ "result": { "address": "北333京市", "province": null, "city": null, "county": null, "town": null, "adcode": null, "citycode": null, "detailaddr": null, "alladdress": null, "errMsg": "地址不详或地址冲突" }, "succ": "fail", "msg": "地址补全失败" }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML