OkayAPI Docs


API Path: /api/App/Common_Address/Choose

API Description: 根据省份、城市、区县、乡镇、村庄,选择地址。选择时,优先以最具体的行政区为准,即:村庄最优先,省份最后。使用时,可依次从province_list中选择省份,从province里选择城市,从city里选择区域……

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
province_codeStringOptaion省份编码
city_codeStringOptaion城市编码
area_codeStringOptaion区县编码
street_codeStringOptaion乡镇编码
village_codeStringOptaion村庄编码

API Debug

KEYREQUIREDVALUE
app_key *Required
province_code Option
city_code Option
area_code Option
street_code Option
village_code Option

API Response

KEYTypeDescription
provinceObject省份信息(若有)
province.codeString省份编码
province.nameString省份名称
province.nextString省份下的城市列表
cityObject城市信息(若有)
city.codeString城市编码
city.nameString城市名称
city.nextString城市下的区县列表
areaObject区县信息(若有)
area.codeString区县编码
area.nameString区县名称
area.nextString区县下的乡镇列表
streetObject乡镇信息(若有)
street.codeString乡镇编码
street.nameString乡镇名称
street.nextString乡镇下的村庄列表
villageObject村庄信息(若有)
village.codeString村庄编码
village.nameString村庄名称
village.nextString下一级列表
province_listArray全国省份列表(固定返回)
province_list[].codeString省份编码
province_list[].nameString省份名称
full_addressString完整的地址,例如:北京市市辖区东城区东华门街道办事处正义路社区居委会

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400表示客户端参数错误
Http Status = 404表示接口服务不存在
Http Status = 500表示服务端内部错误