## 获取地区列表信息(regionList) >[info] 场景说明:获取商城地区列表信息 ### 是否需要获取用户TOKEN `否` ***** ### 请求地址 ``` POST http://api.xxx.com/region/list ``` ### 公共请求参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | appid | string | 必须 | 平台提供的唯一APPID | | version | string | 必须 | 接口版本号,固定填:v3 | | sign\_type | string | 必须 | 签名类型,目前只支持md5 | | timestamp | string | 必须 | 发起时间戳,格式为:yyyy-mm-dd hh::ii::ss | | format | string | 必须 | 返回的数据格式,只支持json | | sign | string | 必须 | 请求参数的签名,请参考:[签名规则](signature.md) | | token | string | 必须 | 访问TOKEN | | params | string | 必须 | 请求参数的集合,除公共参数外,所有请求参数都必须放在这个参数中传递,json\_encode后送入 | 应用请求参数`params`格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | parent\_id | integer | 可选 | 地区父级ID,如果需要获取全量数据,则不传 | | if\_show | integer | 可选 | 地区显示标识,0=只取不显示的地区,1=只取显示的地区,不传则不限制 | | querychild | boolean | 可选 | 是否读取直接下级地区(只读一级),当parent\_id>=0时有效。默认为:false | | page | integer | 可选 | 当前页 | | page\_size | integer | 可选 | 每页读取多少条记录,默认10条 | ### 请求示例 ``` { "appid": "您的APPID", "version": "v3", "sign_type": "md5", "timestamp": "2020-8-10 12:00:00", "format": "json", "sign": "op0987yhjmngt54rtg2wgdfvcder2765", "params": { "parent_id": 0, "querychild": true } } ``` ***** ### 公共返回参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | code | integer | 必须 | 0=成功,其它值代表请求失败的错误代码,请参考:[公共错误码](response-code.md) | | message | string | 必须 | 请求成功/失败的描述信息 | | \+ data | array | 必须 | 返回结果,如果没有数据则返回空 | | └ list | list | 必须 | 地址列表 | | └ pagination | array | 必须 | 分页信息 | 返回`data->list`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | region\_id | integer | 必须 | 地区ID | | region\_name | string | 必须 | 地区名称 | | parent\_id | integer | 必须 | 父级地区ID | | sort\_order | integer | 必须 | 地区排序,取值:0-255 | | if\_show | integer | 必须 | 地区显示标识,0=不显示的地区,1=显示的地区 | | \+ children | list | 可选 | 当querychild=true和parent\_id>=0时有值 | | └ region\_id | integer | 必须 | 地区ID | | └ region\_name | string | 必须 | 地区名称 | | └ parent\_id | integer | 必须 | 父级地区ID | | └ sort\_order | integer | 必须 | 地区排序,取值:0-255 | | └ if\_show | integer | 必须 | 地区显示标识,0=不显示的地区,1=显示的地区 | 返回`data->pagination`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | page | integer | 必须 | 当前页 | | page\_size | integer | 必须 | 每一页显示的数据量 | | page\_count | integer | 必须 | 总页数 | | total | integer | 必须 | 总记录数 | ### 返回数据示例 ``` { "code": 0, "message": "成功", "data": { "list": [ { "region_id": 1, "region_name": "北京", "parent_id": 0, "sort_order": 1, "if_show": 1, "children": [ { "region_id": 2, "region_name": "北京市", "parent_id": 1, "sort_order": 2, "if_show": 1 } ] } ], "pagination": { "page":1, "page_size":10, "page_count":1, "total":1 } } } ```