CDMA无线定位业务应用编程接口(API)技术规范(中兴)(6)

API
技术规范
参数　 appLocation in IpAppUserLocationRef 此参数是用户定位业务回调的应用接口地址 　
users in TpAddressSet 此参数标识请求位置信息报告的用户 　 　
返回值 TpSessionID 　　
异常　 TpCommonExceptions, P_APPLICATION_NOT_ACTIVATED, P_INFORMATION_NOT_AVAILABLE, P_UNKNOWN_SUBSCRIBER 　
方法　 ｅｘｔｅｎｄｅｄＬｏｃａｔｉｏｎＲｅｐｏｒｔＲｅｑ（）　 应用使用此方法向业务请求报告一个或几个用户的高级位置信息 对调用此方法可能产生的异常说明如下 　 P_NO_CALLBACK_ADDRESS_SET 拒绝执行此方法 因为方法中没有设置回调地址 Ｐ＿ＲＥＳＯＵＲＣＥＳ＿ＵＮＡＶＡＩＬＡＢＬＥ　 所要求的网络资源不可用 应用可以尝试在稍后调用此方法 P_UNKNOWN_SUBSCRIBER 终端用户未签约此应用 P_APPLICATION_NOT_ACTIVATED 终端用户已去激活此应用 P_INFORMATION_NOT_AVAILABLE 不允许查询此终端用户位置信息 　 　　 　　
参数　 　 appLocation in IpAppUserLocationRef 此参数是用户定位业务回调的应用接口地址 　
users in TpAddressSet 此参数标识请求位置信息报告的用户 　 25 / 25
无线定位业务应用编程接口
API
技术规范
request in TpLocationRequest 此参数标识对定位业务的额外请求 定位类型 （ｒｅｓｐｏｎｓｅ　ｔｉｍｅ）和优先级（ｐｒｉｏｒｉｔｙ） 　 　 ｌｏｃａｔｉｏｎ　ｔｙｐｅ 精度（ａｃｃｕｒａｃｙ） 响应时间
返回值　 TpSessionID　 　　
异常　 TpCommonExceptions,P_APPLICATION_NOT_ACTIVATED,P_REQUESTED_ACCURA CY_CANNOT_BE_DELIVERED,P_REQUESTED_RESPONSE_TIME_CANNOT_BE_DELIVERED ,P_UNKNOWN_SUBSCRIBER,P_INFORMATION_NOT_AVAILABLE 　
方法　 ｐｅｒｉｏｄｉｃＬｏｃａｔｉｏｎＲｅｐｏｒｔｉｎｇＳｔａｒｔＲｅｑ（）　 应用使用此方法向业务请求定期报告一个或几个用户的位置信息 对调用此方法可能产生的异常说明如下 　 P_NO_CALLBACK_ADDRESS_SET 拒绝执行此方法 因为方法中没有设置回调地址 Ｐ＿ＲＥＳＯＵＲＣＥＳ＿ＵＮＡＶＡＩＬＡＢＬＥ　 所要求的网络资源不可用 应用可以尝试在稍后调用此方法 P_UNKNOWN_SUBSCRIBER 终端用户未签约此应用 P_APPLICATION_NOT_ACTIVATED 终端用户已去激活此应用 P_INFORMATION_NOT_AVAILABLE 不允许查询此终端用户位置信息 　 　 　　
参数　 　 appLocation in IpAppUserLocationRef 此参数是用户定位业务回调的应用接口地址 　
use

rs in TpAddressSet 此参数标识请求位置信息报告的用户 　 ｌｏｃａｔｉｏｎ　ｔｙｐｅ 精度（ａｃｃｕｒａｃｙ） 响应时间
request in TpLocationRequest 此参数标识对定位业务的额外请求 定位类型 （ｒｅｓｐｏｎｓｅ　ｔｉｍｅ）和优先级（ｐｒｉｏｒｉｔｙ） 　　
reportingInterval in TpDuration 此参数指定位置信息报告的时间间隔 　
返回值　 TpSessionID　 　 　 26 / 26
无线定位业务应用编程接口
API
技术规范
异常　 TpCommonExceptions, P_INVALID_REPORTING_INTERVAL, P_REQUESTED_ACCURACY_CANNOT_BE_DELIVERED, P_REQUESTED_RESPONSE_TIME_CANNOT_BE_DELIVERED, P_UNKNOWN_SUBSCRIBER, P_APPLICATION_NOT_ACTIVATED, P_INFORMATION_NOT_AVAILABLE 　
方法　 ｐｅｒｉｏｄｉｃＬｏｃａｔｉｏｎＲｅｐｏｒｔｉｎｇＳｔｏｐ（）　 应用使用此方法向业务请求取消一个或几个用户的位置信息报告 对调用此方法可能产生的异常说明如下 　　 Ｐ＿ＩＮＶＡＬＩＤ＿ＡＳＳＩＧＮＭＥＮＴ＿ＩＤ　 参数 ａｓｓｉｇｎｍｅｎｔＩＤ 无效 　　 　
参数　 stopRequest in TpMobilityStopAssignmentData 此参数说明如何取消指定的位置信息报告 即对全部用户还是对部分用户 　
异常　 TpCommonExceptions, P_INVALID_ASSIGNMENT_ID 　
9.1.2
IpAppUserLocation 接口类 业务使用此接口对应用的用户位置信息请求做出
继承自 ＩｐＩｎｔｅｒｆａｃｅ 　 用户位置的应用接口由客户应用开发商实现 响应 　　
＜＜Ｉｎｔｅｒｆａｃｅ＞＞　 ＩｐＡｐｐＵｓｅｒＬｏｃａｔｉｏｎ　 　 ＬｏｃａｔｉｏｎＲｅｐｏｒｔＲｅｓ　（ａｓｓｉｇｎｍｅｎｔＩｄ ｌｏｃａｔｉｏｎＲｅｐｏｒｔＥｒｒ　（ａｓｓｉｇｎｍｅｎｔＩｄ ＴｐＭｏｂｉｌｉｔｙＤｉａｇｎｏｓｔｉｃ） ｖｏｉｄ　 ｉｎ　ＴｐＳｅｓｓｉｏｎＩＤ，　ｌｏｃａｔｉｏｎｓ ｉｎ　ＴｐＳｅｓｓｉｏｎＩＤ，　ｃａｕｓｅ ｉｎ　ＴｐＵｓｅｒＬｏｃａｔｉｏｎＳｅｔ） ｖｏｉｄ　 ｉｎ　
ｉｎ　ＴｐＭｏｂｉｌｉｔｙＥｒｒｏｒ，　ｄｉａｇｎｏｓｔｉｃ ｉｎ　
ｅｘｔｅｎｄｅｄＬｏｃａｔｉｏｎＲｅｐｏｒｔＲｅｓ　（ａｓｓｉｇｎｍｅｎｔＩｄ ＴｐＵｓｅｒＬｏｃａｔｉｏｎＥｘｔｅｎｄｅｄＳｅｔ） ｖｏｉｄ　 ｅｘｔｅｎｄｅｄＬｏｃａｔｉｏｎＲｅｐｏｒｔＥｒｒ　（ａｓｓｉｇｎｍｅｎｔＩｄ ｉｎ　ＴｐＭｏｂｉｌｉｔｙＤｉａｇｎｏｓｔｉｃ） ｖｏｉｄ　 ｐｅｒｉｏｄｉｃＬｏｃａｔｉｏｎＲｅｐｏｒｔ　（ａｓｓｉｇｎｍｅｎｔＩｄ ｖｏｉｄ　
ｉｎ　ＴｐＳｅｓｓｉｏｎＩＤ，　ｌｏｃａｔｉｏｎｓ ｉｎ　ＴｐＳｅｓｓｉｏｎＩＤ，　ｃａｕｓｅ
ｉｎ　ＴｐＭ

ｏｂｉｌｉｔｙＥｒｒｏｒ，　ｄｉａｇｎｏｓｔｉｃ ｉｎ　ＴｐＵｓｅｒＬｏｃａｔｉｏｎＥｘｔｅｎｄｅｄＳｅｔ） ｉｎ　ＴｐＭｏｂｉｌｉｔｙＥｒｒｏｒ，　ｄｉａｇｎｏｓｔｉｃ
ｉｎ　ＴｐＳｅｓｓｉｏｎＩＤ，　ｌｏｃａｔｉｏｎｓ ｉｎ　ＴｐＳｅｓｓｉｏｎＩＤ，　ｃａｕｓｅ
ｐｅｒｉｏｄｉｃＬｏｃａｔｉｏｎＲｅｐｏｒｔＥｒｒ　（ａｓｓｉｇｎｍｅｎｔＩｄ ｉｎ　ＴｐＭｏｂｉｌｉｔｙＤｉａｇｎｏｓｔｉｃ） ｖｏｉｄ　
方法　 ｌｏｃａｔｉｏｎＲｅｐｏｒｔＲｅｓ（）　 业务使用此方法向应用报告一个或几个用户的位置信息 　 27 / 27
无线定位业务应用编程接口
API
技术规范
参数　 assignmentId in TpSessionID 此参数标识指定的位置报告请求 　 　
locations in TpUserLocationSet 此参数表示一个或几个用户的位置信息 　
方法　 ｌｏｃａｔｉｏｎＲｅｐｏｒｔＥｒｒ（）　 业务使用此方法向应用指示所请求的位置报告失败 　　
参数　 assignmentId in TpSessionID 此参数标识指定的位置报告请求 此参数标识导致故障的原因 　 　 　
cause in TpMobilityError diagnostic in TpMobilityDiagnostic 此参数标识导致故障的额外信息 　
方法　 ｅｘｔｅｎｄｅｄＬｏｃａｔｉｏｎＲｅｐｏｒｔＲｅｓ（）　 业务使用此方法向应用报告一个或几个用户的扩展位置信息 　　
参数　 assignmentId in TpSessionID 此参数标识指定的位置报告请求 　 　
locations in TpUserLocationExtendedSet 此参数标识一个或几个用户的扩展位置信息 　
方法　 ｅｘｔｅｎｄｅｄＬｏｃａｔｉｏｎＲｅｐｏｒｔＥｒｒ（）　 业务使用此方法向应用指示所请求的位置报告失败 　 　　
参数　 　 assignmentId in TpSessionID 此参数标识指定的位置报告请求 此参数标识导致故障的原因 　 　 　
cause in TpMobilityError diagnostic in TpMobilityDiagnostic 此参数标识导致故障的额外信息 　 　
28 / 28
无线定位业务应用编程接口
API
技术规范
方法　 ｐｅｒｉｏｄｉｃＬｏｃａｔｉｏｎＲｅｐｏｒｔ（）　 业务使用此方法向应用定期报告一个或几个用户的位置信息
参数　 assignmentId in TpSessionID 此参数标识指定的定期位置信息报告请求 此参数表示一个或几个用户的位置信息 　
locations in TpUserLocationExtendedSet
方法　 ｐｅｒｉｏｄｉｃＬｏｃａｔｉｏｎＲｅｐｏｒｔＥｒｒ（）　 业务使用此方法向应用指示一个请求的定期位置报告失败 ｐｅｒｉｏｄｉｃＬｏｃａｔｉｏｎＲｅｐｏｒｔ（）方法中给出 　　 请注意 仅涉及单个用户的错误在
参数　 assignmentId in TpSessionID 此参数标识已失败的定期位置报告请求 　

cause in TpMobilityError 此参数说明导致故障的原因 　 　
diagnostic in TpMobilityDiagnostic 此参数说明导致故障的额外信息
9.1.3
IpTriggeredUserLocation 接口类
继承自 ＩｐＵｓｅｒＬｏｃａｔｉｏｎ 　 此接口可以被用作用户定位 Ｕｓｅｒ　Ｌｏｃａｔｉｏｎ 业务的扩展 　 IpTriggeredUserLocation 接口提供按条件触发的用户位置功能 应用开发商可以使用此接口请求 由位置变化触发的用户位置报告 　　 ＜＜Ｉｎｔｅｒｆａｃｅ＞＞　 ＩｐＴｒｉｇｇｅｒｅｄＵｓｅｒＬｏｃａｔｉｏｎ　 　 ｔｒｉｇｇｅｒｅｄＬｏｃａｔｉｏｎＲｅｐｏｒｔｉｎｇＳｔａｒｔＲｅｑ　（ａｐｐＬｏｃａｔｉｏｎ ｉｎ　ＩｐＡｐｐＴｒｉｇｇｅｒｅｄＵｓｅｒＬｏｃａｔｉｏｎＲｅｆ，　ｕｓｅｒｓ ｉｎ　 ＴｐＡｄｄｒｅｓｓＳｅｔ，　ｒｅｑｕｅｓｔ ｉｎ　ＴｐＬｏｃａｔｉｏｎＲｅｑｕｅｓｔ，　ｔｒｉｇｇｅｒｓ ｉｎ　ＴｐＬｏｃａｔｉｏｎＴｒｉｇｇｅｒＳｅｔ） ＴｐＳｅｓｓｉｏｎＩＤ　 ｔｒｉｇｇｅｒｅｄＬｏｃａｔｉｏｎＲｅｐｏｒｔｉｎｇＳｔｏｐ　（ｓｔｏｐＲｅｑｕｅｓｔ ｉｎ　ＴｐＭｏｂｉｌｉｔｙＳｔｏｐＡｓｓｉｇｎｍｅｎｔＤａｔａ） ｖｏｉｄ　
方法　 ｔｒｉｇｇｅｒｅｄＬｏｃａｔｉｏｎＲｅｐｏｒｔｉｎｇＳｔａｒｔＲｅｑ（）　 应用使用此方法向业务请求当用户位置变化时报告用户的位置信息（报告由位置变化触发引 起） 　　
参数　 appLocation in IpAppTriggeredUserLocationRef 此参数标识触发式用户位置业务回调的应用接口 　 29 / 29
无线定位业务应用编程接口
API
技术规范
users in TpAddressSet 此参数标识请求位置信息报告的用户 此参数标识请求的位置类型 此参数设置触发条件 　 　 精度 　 响应时间和优先权 　
request in TpLocationRequest triggers in TpLocationTriggerSet