火车票城市搜索
调用本接口可实现火车票城市的搜索功能,支持根据用户输入的关键词进行城市名称和城市码的模糊匹配,适用于企业差旅场景中的火车票预订流程。
使用场景
该接口主要用于企业差旅管理系统中火车票预订环节的城市搜索功能。典型使用场景包括:
用户在提交出差申请或预订火车票时,输入城市名称关键字(如“杭州”、“汉口”),系统通过该接口实时返回匹配的城市列表,实现自动补全建议。
在行程创建页面中,用于选择出发地或目的地城市,提升用户输入效率与准确性。
与阿里商旅系统集成,为企业内部员工提供统一、标准化的城市数据源,确保城市信息的一致性。
权限
服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。
应用类型 | 是否支持调用 | 权限申请方式 | API Explorer调试 |
企业内部应用 | 是 | 阿里商旅专用权限点 | |
第三方企业应用 | 是 | 阿里商旅专用权限点 | |
第三方个人应用 | 否 | — | — |
基本信息
请求方式:POST
请求地址:https://oapi.dingtalk.com/topapi/alitrip/btrip/train/city/suggest
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
access_token | String | 是 | 6d1bxxx | 调用该API的应用凭证。
|
Body参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
rq | SuggestRq | 是 | 请求对象。 | |
keyword | String | 是 | 杭州 | 搜索关键字,用于匹配城市名称或城市码。 |
userid | String | 是 | user1 | 当前操作用户的ID,用于上下文识别与权限校验。 |
corpid | String | 是 | corp1 | 企业标识ID,用于确定所属企业数据范围。 |
返回参数
名称 | 类型 | 示例值 | 描述 |
result | SuggestRs | 结果对象。 | |
cities | CityVo[] | 城市列表。 | |
name | String | 杭州 | 城市名称。 |
code | String | HGH | 城市码。 |
errmsg | String | ok | 返回码描述。 |
errcode | Number | 0 | 返回码。 |
success | Boolean | true | 成功标识。 |
示例
请求示例(HTTP)
POST https://oapi.dingtalk.com/topapi/alitrip/btrip/train/city/suggest?access_token=ACCESS_TOKEN请求正文
{
"rq":{
"corpid":"corp1",
"type":"0",
"userid":"user1"
}
}请求示例(JAVA SDK)
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/alitrip/btrip/train/city/suggest");
OapiAlitripBtripTrainCitySuggestRequest req = new OapiAlitripBtripTrainCitySuggestRequest();
SuggestRq obj1 = new SuggestRq();
obj1.setKeyword("杭州");
obj1.setUserid("user1");
obj1.setCorpid("corp1");
req.setRq(obj1);
OapiAlitripBtripTrainCitySuggestResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());返回示例
{
"result":{
"cities":{
"code":"hk",
"name":"汉口"
}
},
"errcode":"0",
"success":"true",
"errmsg":"成功"
}