顺丰校园管家


校内地址查询

<h3>功能描述</h3> <ul> <li>根据学校id查询校内地址。 <h3>接入前须知</h3></li> <li>请联系 王歆悦 进行校园验签key及默认下单人配置</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/schoolPub/querySchoolAddress</td> </tr> </tbody> </table> <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;">必填</th> <th style="text-align: center;">默认值</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">schoolAppId</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">由校园系统方提供,用来单独验证</td> </tr> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">addressType</td> <td style="text-align: center;">Number (2)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">地址类型0校内地址1驿站</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">schoolId</td> <td style="text-align: center;">Long</td> <td style="text-align: center;">是</td> <td style="text-align: center;">学校ID</td> </tr> </tbody> </table> <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;">必填</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;SchoolAddressSettingEntity&gt; (/)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">数据</td> <td style="text-align: left;">数据,可能为空</td> </tr> </tbody> </table> <h4>响应result&lt;List&gt;</h4> <h5>SchoolAddressSettingEntity</h5> <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;">schoolId</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">学校ID</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">schoolName</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;">addressTree</td> <td style="text-align: center;">List&lt;SchoolAddressTreeEntity&gt;</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;">addressType</td> <td style="text-align: center;">Number (2)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">地址类型0其他1驿站</td> </tr> </tbody> </table> <h5>SchoolAddressTreeEntity</h5> <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(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;">level</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">是</td> <td style="text-align: center;">地址等级0开始</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">parentId</td> <td style="text-align: center;">Long</td> <td style="text-align: center;">是</td> <td style="text-align: center;">上级id</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">children</td> <td style="text-align: center;">List&lt;SchoolAddressTreeEntity&gt;</td> <td style="text-align: center;">是</td> <td style="text-align: center;">数据</td> <td style="text-align: left;">数据,可能为空</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{&amp;quot;schoolAppId&amp;quot;:&amp;quot;a&amp;quot;,&amp;quot;schoolId&amp;quot;:&amp;quot;884328609426243584&amp;quot;,&amp;quot;addressType&amp;quot;:0}</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ &amp;quot;result&amp;quot;: [{ &amp;quot;id&amp;quot;: 978916445740011520, &amp;quot;schoolId&amp;quot;: 884328609426243584, &amp;quot;schoolName&amp;quot;: &amp;quot;测试学校&amp;quot;, &amp;quot;addressType&amp;quot;: 1, &amp;quot;modifierUser&amp;quot;: &amp;quot;12301230050&amp;quot;, &amp;quot;modifyTm&amp;quot;: &amp;quot;2024-08-03 17:53:16&amp;quot;, &amp;quot;createUser&amp;quot;: &amp;quot;18320628999&amp;quot;, &amp;quot;createTm&amp;quot;: &amp;quot;2024-08-01 17:11:18&amp;quot;, &amp;quot;addressTree&amp;quot;: [{ &amp;quot;id&amp;quot;: 978916445740011521, &amp;quot;addressId&amp;quot;: 978916445740011520, &amp;quot;address&amp;quot;: &amp;quot;驿站之顺丰驿站牛&amp;quot;, &amp;quot;level&amp;quot;: 0, &amp;quot;parentId&amp;quot;: null, &amp;quot;createUser&amp;quot;: &amp;quot;18320628999&amp;quot;, &amp;quot;createTm&amp;quot;: &amp;quot;2024-08-01 17:11:18&amp;quot;, &amp;quot;children&amp;quot;: [{ &amp;quot;id&amp;quot;: 978916445740011522, &amp;quot;addressId&amp;quot;: 978916445740011520, &amp;quot;address&amp;quot;: &amp;quot;驿站子节点子牛牛&amp;quot;, &amp;quot;level&amp;quot;: 1, &amp;quot;parentId&amp;quot;: 978916445740011521, &amp;quot;createUser&amp;quot;: &amp;quot;18320628999&amp;quot;, &amp;quot;createTm&amp;quot;: &amp;quot;2024-08-01 17:11:18&amp;quot;, &amp;quot;children&amp;quot;: [] }] }, { &amp;quot;id&amp;quot;: 978916445740011523, &amp;quot;addressId&amp;quot;: 978916445740011520, &amp;quot;address&amp;quot;: &amp;quot;驿站2&amp;quot;, &amp;quot;level&amp;quot;: 0, &amp;quot;parentId&amp;quot;: null, &amp;quot;createUser&amp;quot;: &amp;quot;18320628999&amp;quot;, &amp;quot;createTm&amp;quot;: &amp;quot;2024-08-01 17:11:18&amp;quot;, &amp;quot;children&amp;quot;: [{ &amp;quot;id&amp;quot;: 978916445740011524, &amp;quot;addressId&amp;quot;: 978916445740011520, &amp;quot;address&amp;quot;: &amp;quot;驿站子节点2&amp;quot;, &amp;quot;level&amp;quot;: 1, &amp;quot;parentId&amp;quot;: 978916445740011523, &amp;quot;createUser&amp;quot;: &amp;quot;18320628999&amp;quot;, &amp;quot;createTm&amp;quot;: &amp;quot;2024-08-01 17:11:18&amp;quot;, &amp;quot;children&amp;quot;: [] }, { &amp;quot;id&amp;quot;: 978917744165810176, &amp;quot;addressId&amp;quot;: 978916445740011520, &amp;quot;address&amp;quot;: &amp;quot;初始大口径的坑&amp;quot;, &amp;quot;level&amp;quot;: 1, &amp;quot;parentId&amp;quot;: 978916445740011523, &amp;quot;createUser&amp;quot;: &amp;quot;18320628999&amp;quot;, &amp;quot;createTm&amp;quot;: &amp;quot;2024-08-01 17:16:28&amp;quot;, &amp;quot;children&amp;quot;: [] } ] }, { &amp;quot;id&amp;quot;: 978917819541647360, &amp;quot;addressId&amp;quot;: 978916445740011520, &amp;quot;address&amp;quot;: &amp;quot;初始3&amp;quot;, &amp;quot;level&amp;quot;: 0, &amp;quot;parentId&amp;quot;: null, &amp;quot;createUser&amp;quot;: &amp;quot;18320628999&amp;quot;, &amp;quot;createTm&amp;quot;: &amp;quot;2024-08-01 17:16:46&amp;quot;, &amp;quot;children&amp;quot;: [] } ] }], &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;, &amp;quot;msg&amp;quot;: null, &amp;quot;extendResult&amp;quot;: null }</code></pre></li> <li>失败报文-范例1 <pre><code>{ &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;所选订单类型不存在&amp;quot; }</code></pre></li> <li>失败报文-范例2 <pre><code>{ &amp;quot;msg&amp;quot;:&amp;quot;未校验到下单人数据&amp;quot;, &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML