广东电信定位能力平台
接口说明书
广东亿迅科技有限公司
2010-03-31
目 录
1、 概述 1
2、 协议说明 1
2.1 安全部分 1
2.2 接口SOAP协议 1
3、 参数说明 1
3.1 单次定位请求参数 1
3.2 单次定位返回结果 2
4、 结果代码和错误代码 2
4.1 通用结果集 2
4.2 个别错误代码 3
1、概述
定位接口为企业提供了二次开发接口,接口采用标准的WebService接口,开发非常便捷。
2、协议说明
接口形式采用WebService(SOAP),安全认证部分采用标准的WSS(WebService Security)。
2.1 安全部分
接口采用WSS来验证调用者的身份,验证方法如下:
action:UsernameToken
passwordType:PasswordDigest
具体客户端的实现方式请参考所选用的技术框架说明书
2.2 安全规则说明
接口系统支持2类客户:
1.网关类(ISAG)接入:提供无功能但有IP访问控制的接口。
2.物流e通客户:无IP访问,但仅能对属于本企业的用户进行定位。
2.3 接口SOAP协议
具体协议的WSDL请双击打开附件,WSDL中带字段说明
3、参数说明
3.1 单次定位请求参数
| 字段名称 | 类型 | 说明 |
| CallerInfo.CallerId | 调用者标识 | 按分配的ID填写 |
| Terminal.Number | 号码 | 被定位手机号 |
| Terminal.PosType | 定位类型 | 暂时只提供GPSone/GPS方式 |
| 字段名称 | 类型 | 说明 |
| CallerInfo.CallerId | 调用者标识 | 按分配的ID填写 |
| Result. ReturnCode | 返回码 | 0表示成功,6开头的错误请查询后面的出错码附表 |
| PosInfo. PositionResult | 定位的结果 | 含义请参考后面的码表 |
| PosInfo.Number | 被定位手机号 | 被定位的手机号 |
| PosInfo.PosType | 定位类型 | 目前支持GPSone |
| PosInfo.LocalTime | 本地时间 | 国内都是+8时区,格式yyyyMMddHHmiss |
| PosInfo.Longitude | 经度 | 默认用D5格式,例如113.33305 |
| PosInfo.Latitude | 纬度 | 默认用D5格式,例如23.14127 |
| PosInfo.Radius | 误差 | 单位是米 |
| PosInfo.PosMethod | 定位方法 | 说明定位时所用的定位信号 |
4.1 通用结果集
下表显示的是表示全部请求结果的通用结果集。
| 结果代码 | 符号 | 说明 |
| 0 | OK | 处理请求过程中没有错误 |
| 1 | SYSTEM FAILURE | 因为位置服务器或基础网络中发生故障而无法处理请求 |
| 2 | CONGESTION IN LOCATION SERVER | 因位置服务器忙而无法处理请求 |
| 3 | CONGESTION IN MOBILE NETWORK | 因移动网络忙而无法处理请求 |
| 4 | UNAUTHORISED APPLICATION | 不允许位置应用访问位置服务器 |
| 5 | INCORRECT PASSWORD | 位置应用允许访问位置服务器,但提供的口令不正确 |
| 6 | TOO MANY POSITION ITEMS | 请求中确定了太多的位置项 |
| 7 | Format ERROR | 请求中参数的格式不对 |
| 8 | SYNTAX ERROR | 位置请求的语法不对 |
| 9 | PROTOCOL ELEMENT NOT SUPPORTED | 本实施中不支持位置请求中定义的元素。 |
| 10 | INVALID REQ_ID | 因REQ-ID无效,无法执行 LCTR |
下表显示的是请求中提供的针对每个移动用户的个别错误代码。
| 结果代码 | 符号 | 说明 |
| 100 | UNKNOWN LCSClient | LCS Client 未知 |
| 101 | UNKNOWN ORIGINATOR | 发起定位的用户未知 |
| 102 | UNKNOWN SUBSCRIBER | 定位用户未知 |
| 103 | UNAUTHORIZED LCS CLIENT | LCS Client未授权或者密码不符 |
| 104 | ABSENT SUBSCRIBER | 用户目前不可到达 |
| 105 | POSITION METHOD FAILURE | 因暂时性位置方法问题,位置服务器无法确定MS的位置 |
| 106 | NOT IN PRIVACY EXCEPTION LIST | 请求应用不在MS的私人例外表中 |
| 107 | CONGESTION IN NETWORK | 对用户定位时移动网络忙 |
| 108 | CONGESTION IN LOCATION SERVER | 对用户定位时位置服务器忙 |
| 109 | LOCATION METHOD NOT SUPPORTED | MS 不支持被请求的位置方法 |
| 110 | QOS NOT ATTAINABLE | 无法获得在服务质量中说明的被请求时间要求 |
| 111 | NETWORK ERROR | 基础网络中出现故障 |
| 112 | LACK OF ACCOUNT | 用户余额不足 |
| 113 | NONE ACCOUNT | 用户欠费 |
| 114 | MS LOST | 移动台挂失 |
| 115 | LCS Client Denied | CP在用户列表中完全拒绝 |
| 116 | LCS Client Time Restricted | CP该时间段不允许 |
| 117 | User Pass Error | 主叫用户密码错 |
| 118 | Calling Time Restricted | 主叫用户该时间段不允许 |
| 119 | NONE LCS Client ACCOUNT | CP欠费 |
| 120 | UNAUTHORIZED Third Party LCS CLIENT | CP无第三方查询的权限 |
| 说明:定位结果值 | |||
| 格式: | Int | ||
| 定义值: | 1:初始位置;2:最新位置;3:最近已知位置......详细定义参见本节备注 | ||
| 默认值: | - | ||
| 举例: | |||
| 备注: 详细定义: | |||
| 值 | 含义 | ||
| 0 | 未使用 | ||
| 1 | 返回的是初始位置 | ||
| 2 | 返回的是更新后的位置 | ||
| 3 | 返回的是最近一次的位置 | ||
| 4 | 所请求的位置信息不可得 | ||
| 5 | 目标MS断开。目标MS不再有分配的业务信道(例如MS话音呼叫已断开)并且定位业务是与话音呼叫相关的。 | ||
| 6 | 目标MS已切换。由于切换而使位置不可得(例如,切换至无定位能力的系统) | ||
| 7 | MS已去激活或漫游至其它系统 | ||
| 8 | 无响应 | ||
| 9 | MS有响应,但拒绝位置请求 | ||
| 10 | 系统失败 | ||
| 11 | 未知的MSID | ||
| 12 | 回叫号码未知 | ||
| 13 | 无效的请求信息(例如,无效的信道信息,无效的ESN) | ||
| 14 | 返回的是手机的信道信息 | ||
| 15 | 未检测到信号 | ||
| 16 | PDE超时 | ||
| 17 | 位置未确定 | ||
| 18 | 返回的是TDMA MAHO信息 | ||
| 19 | TDMA MAHO信息不可得 | ||
| 20 | 接入拒绝(例如,请求方未授权) | ||
| 21 | 所请求的PQOS无法达到 | ||
| 22 | CDMA中基于移动台的定位所需的资源目前不可得。目标MS目前不能进行基于移动台的定位操作(例如,业务信道不可用) | ||
| 23 | CDMA中基于移动台的定位操作失败。 | ||
| 24 | CDMA中基于移动台的定位操作不能被PDE触发。 | ||
| 25 | CDMA中基于移动台的定位操作未完成——业务信道用于话音业务。CDMA中基于移动台的定位操作不能完成,因为业务信道被释放以用于向话音业务提供资源 | ||
| 其它值 | 未使用 | ||