城市搜索
城市搜索API提供全球地理位位置、全球城市搜索服务,支持经纬度坐标反查、多语言、模糊搜索等功能。
天气数据是基于地理位置的数据,因此获取天气之前需要先知道具体的位置信息。使用城市搜索,可获取到该城市的基本信息,包括城市的Location ID(你需要这个ID去查询天气),多语言名称、经纬度、时区、海拔、Rank值、归属上级行政区域、所在行政区域等。
另外,城市搜索也可以帮助你在你的APP中实现模糊搜索,用户只需要输入1-2个字即可获得结果。
接口代码(枚举) | 接口 | 数据类 |
---|---|---|
INQUIRE_TYPE_GEO_CITY_LOOKUP | 城市查询 | GeoBaseClass |
请求参数
请求参数包括必选和可选参数,如不填写可选参数将使用其默认值。
-
location
(必选)需要查询地区的名称,支持文字、以英文逗号分隔的经度,纬度坐标(十进制,最多支持小数点后两位)、LocationID或Adcode(仅限中国城市)。例如location=北京
或location=116.41,39.92
-
lang
多语言设置,请阅读多语言文档,了解我们的多语言是如何工作、如何设置以及数据是否支持多语言。 -
adm
城市的上级行政区划,可设定只在某个行政区划范围内进行搜索,用于排除重名城市或对结果进行过滤。例如adm=beijing
-
range
搜索范围,可设定只在某个国家或地区范围内进行搜索,国家和地区名称需使用ISO 3166 所定义的国家代码。如果不设置此参数,搜索范围将在所有城市。例如range=cn
-
number
返回结果的数量,取值范围1-20,默认返回10个结果。
示例代码
QWeatherConfigInstance.publicID = @"publicID";
QWeatherConfigInstance.appKey = @"key";
QWeatherConfigInstance.appType = APP_TYPE_BIZ;
QWeatherConfigInstance.location = @"beijing";
[QWeatherConfigInstance weatherWithInquireType:INQUIRE_TYPE_GEO_CITY_LOOKUP WithSuccess:^(GeoBaseClass *responseObject) {
NSLog(@"描述->%@",[responseObject description]);
} faileureForError:^(NSError *error) {
NSLog(@"error->%@",error);
}];
返回数据
参数 | 描述 | 示例 |
---|---|---|
code | 状态码,具体含义请参考状态码 | 200 |
location.name | 地区/城市名称 | 南山区 |
location.cid | 地区/城市ID | 101280604 |
location.lat | 地区/城市纬度 | 22.53122 |
location.lon | 地区/城市经度 | 113.92942 |
location.adm2 | 该地区/城市的上级行政区划名称 | 深圳市 |
location.adm1 | 该地区/城市所属一级行政区域 | 广东省 |
location.country | 该地区/城市所属国家名称 | 中国 |
location.tz | 该地区/城市所在时区 | +0800 |
location.utcOffset | 该地区/城市目前与UTC时间偏移的小时数,参考详细说明 | +08:00 |
location.isDst | 该地区/城市是否当前处于夏令时 | 0 |
location.type | 该地区/城市的属性 | city |
location.rank | 地区评分 | 10 |
location.fxLink | 该地区的天气预报网页链接,便于嵌入你的网站或应用 | http://hfx.link/34T5 |
refer.sources | 原始数据来源,可能为空 | |
refer.license | 使用许可,可能为空 |