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

更新时间:2023-04-15 16:30:01 阅读量: 实用文档 文档下载

说明:文章内容仅供预览,部分内容可能不全。下载后的文档,内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的,是否完整无缺。

无线定位业务应用编程接口
API
技术规范 
The Technical Specification of Wireless Location Service APIV1.0  
2002 年 5 月
无线定位业务应用编程接口
API
技术规范
目 录1 范 围 ...............................................................................................................................................................................................5 2 引 用 标 准 .......................................................................................................................................................................................5 3 缩 约 语 ...........................................................................................................................................................................................6 4 L1 接 口 说 明 ................................................................................................................................................................................7 5 移 动 性 SCF .................................................................................................................................................................................8 6 业 务 流 程 图 ..................................................................................................................................................................................9 6.1 用户定位业务流程图 .......................................................................................................................................................9 6.1.1 用户位置查询 – 触发请求 .....................................................................................................................................9 6.1.2 用户位置查询 – 定期请求 .....................................................................................................................................9 6.1.3 用户位置查询 – 参数错误 .................................................................................................................................. 10 6.1.4 用户位置查询 – 网络错误 ...................................................................................................................................11 6.1.5 用户位置查询 – 交互式请求 ..............................................................................................................................11 6.2 基于网络的用户定位业务流程图 ..............................................................................................................................12 6.2.1 基于网络的用户定位查询 – 触发请求 ........................................................................................................... 12 6.2.2 基于网络的用户定位查询 – 定期请求 ....................................................................................................

....... 12 6.2.3 基于网络的用户定位查询 – 参数错误 ........................................................................................................... 13 6.2.4 基于网络的用户定位查询 – 网络错误 ........................................................................................................... 13 6.2.5 基于网络的用户定位查询 – 交互式请求 ....................................................................................................... 14 6.3 用户状态业务流程图 .....................................................................................................................................................14 6.3.1 触发式状态信息报告 ............................................................................................................................................. 14 6.3.2 交互式请求参数错误 ............................................................................................................................................. 15 6.3.3 交互式请求网络错误 ............................................................................................................................................. 15 6.3.4 交互式请求 .............................................................................................................................................................. 16 7 接 口 类 层 次 图 ........................................................................................................................................................................... 17 7.1 用户定位接口类层次图 ................................................................................................................................................17 7.2 基于网络的用户定位业务接口类层次图 .................................................................................................................18 7.3 用户状态接口类层次图 ................................................................................................................................................19 8 业 务 接 口 规 范 ........................................................................................................................................................................... 21 8.1 接口规范格式 ..................................................................................................................................................................21 8.1.1 接口类 ....................................................................................................................................................................... 21 8.1.2 方法描述 ................................................................................................................................................................... 21 8.1.3 参数描述 ...............................................................

.................................................................................................... 21 8.1.4 状态模型 ................................................................................................................................................................... 21 8.2 基本接口 ...........................................................................................................................................................................22 8.2.1 IpInterface 接口类 .................................................................................................................................................. 22 8.3 业务接口 ...........................................................................................................................................................................222/ 2
无线定位业务应用编程接口
API
技术规范
8.3.1 概览 ............................................................................................................................................................................ 22 8.4 一般业务接口 ..................................................................................................................................................................22 8.4.1IpService 接口类 .................................................................................................................................................. 22 9 移 动 性 接 口 类 ........................................................................................................................................................................... 24 9.1 用户定位接口类 ..............................................................................................................................................................24 9.1.1 IpUserLocation 接口类 .......................................................................................................................................... 24 9.1.2 IpAppUserLocation 接口类 ................................................................................................................................... 27 9.1.3 IpTriggeredUserLocation 接口类......................................................................................................................... 29 9.1.4 IpAppTriggeredUserLocation 接口类.................................................................................................................. 30 9.2 基于网络的用户定位接口类 .......................................................................................................................................31 9.2.1 IpUserLocationNetwork 接口类 ........................................................................................................................... 31 9.2.2 IpAppUserLocationNetwork 接口类....................................................................

................................................ 35 9.3 用户状态接口类 ..............................................................................................................................................................37 9.3.1 IpAppUserStatus 接口类 ........................................................................................................................................ 37 9.3.2 IpUserStatus 接口类 ............................................................................................................................................... 38 10 状 态 转 移 图 ............................................................................................................................................................................... 41 10.1 用户定位 ...........................................................................................................................................................................41 10.2 基于网络的用户定位 .....................................................................................................................................................41 10.2.1 IpUserLocationNetwork 状态转移图 .................................................................................................................. 41 10.3 用户状态 ...........................................................................................................................................................................42 10.3.1 IpUserStatus 状态转移图 ...................................................................................................................................... 42 10.3.2 Active 状态................................................................................................................................................................ 42 11 业 务 属 性 .................................................................................................................................................................................... 43 11.1 与移动性相关的属性 .....................................................................................................................................................43 11.1.1 紧急应用子类 .......................................................................................................................................................... 43 11.1.2 增值应用子类 .......................................................................................................................................................... 43 11.1.3 移动运营商应用子类 ............................................................................................................................................. 43 11.1.4 合法截取应用子类 ................................................................................................................................................. 43 11.1

.5 可否获得海拔高度 ................................................................................................................................................. 43 11.1.6 定位方法 ................................................................................................................................................................... 43 11.1.7 优先权 ....................................................................................................................................................................... 44 11.1.8 最大交互式请求数 ................................................................................................................................................. 44 11.1.9 最大触发用户数 ...................................................................................................................................................... 44 11.1.10 11.1.11 最大定期用户数 .......................................................................................................................................... 44 最小定期间隔时间 .......................................................................................................................................... 44
11.2 用户定位业务属性 .........................................................................................................................................................44 11.3 基于网络的用户定位业务属性 ...................................................................................................................................45 11.4 用户状态业务属性 .........................................................................................................................................................46 12 数 据 定 义 .................................................................................................................................................................................... 47 12.1 与移动性相关的公共数据定义 ...................................................................................................................................47 12.1.1 TpGeographicalPosition........................................................................................................................................ 47
3/ 3
无线定位业务应用编程接口
API
技术规范
12.1.2 TpLocationPriority.................................................................................................................................................. 49 12.1.3 TpLocationRequest.................................................................................................................................................. 49 12.1.4 TpLocationResponseIndicator............................................................................................................................... 50 12.1.5 TpLocationResponseTime..........................

............................................................................................................. 50 12.1.6 TpLocationType........................................................................................................................................................ 50 12.1.7 TpLocationUncertaintyShape................................................................................................................................ 51 12.1.8 TpMobilityDiagnostic............................................................................................................................................. 51 12.1.9 TpMobilityError....................................................................................................................................................... 51 12.1.10 12.1.11 12.1.12 TpMobilityStopAssignmentData..................................................................................................................... 52 TpMobilityStopScope....................................................................................................................................... 52 TpTerminalType................................................................................................................................................. 52
12.2 用户定位数据定义 .........................................................................................................................................................53 12.2.1 TpUlExtendedData.................................................................................................................................................. 53 12.2.2 TpUlExtendedDataSet............................................................................................................................................. 53 12.2.3 TpUserLocationExtended....................................................................................................................................... 53 12.2.4 TpUserLocationExtendedSet.................................................................................................................................. 54 12.2.5 TpLocationTrigger................................................................................................................................................... 54 12.2.6 TpLocationTriggerSet............................................................................................................................................. 54 12.2.7 TpLocationTriggerCriteria.................................................................................................................................... 54 12.2.8 TpUserLocation........................................................................................................................................................ 54 12.2.9 TpUserLocationSet.........................................................................................................................

......................... 55 12.3 基于网络的用户定位数据定义 ...................................................................................................................................55 12.3.1 TpLocationCellIDOrLAI ........................................................................................................................................ 55 12.3.2 TpLocationTriggerNetwork.................................................................................................................................... 55 12.3.3 TpUserLocationNetwork ........................................................................................................................................ 56 12.3.4 TpUserLocationNetworkSet................................................................................................................................... 56 12.4 用户定位紧急数据定义 ................................................................................................................................................56 12.4.1 TpIMEI....................................................................................................................................................................... 56 12.4.2 TpNaESRD................................................................................................................................................................ 57 12.4.3 TpNaESRK................................................................................................................................................................ 57 12.4.4 TpUserLocationEmergencyRequest...................................................................................................................... 57 12.4.5 TpUserLocationEmergency.................................................................................................................................... 57 12.4.6 TpUserLocationEmergencyTrigger...................................................................................................................... 58 12.5 用户状态数据定义 .........................................................................................................................................................58 12.5.1 TpUserStatus............................................................................................................................................................ 58 12.5.2 TpUserStatusSet....................................................................................................................................................... 59 12.5.3 TpUserStatusIndicator............................................................................................................................................ 59 12.6 参数计量单位与范围 .....................................................................................................................................................59 13 异 常

处 理 类 ............................................................................................................................................................................... 61
4/ 4
无线定位业务应用编程接口
API
技术规范
1 范围本规范定义了基于开放业务接入 OSA 的 CDMA 移动定位中心 MPC 与应用开发商之间的应用编 程接口 API 开放业务接入采用一种开放的 标准的 统一的网络应用编程接口 API Application Program Interface 为应用开发商提供业务加载手段 通过这些标准的 API 业务应用程序可以方 便地利用承载网络的业务能力 而又不必了解承载网络的信令细节 有关开放业务接入的概念和功 能结构请参见文献[3] 对开放业务接入的要求请参见文献[2]   本规范涉及 CDMA 移动网络的移动性业务能力特征 SCF 接口的内容 与此业务能力特征相关 的所有方面均在此规范中定义 内容包括   - 业务流程图   - 接口类层次图   - 接口规范以及对方法的详细描述   - 状态转移图   - 数据定义   - IDL 接口描述   本规范通过由统一建模语言 UML 描述的对象建模技术来完成上述任务  
2 引用标准下列文件中的条款通过本标准的引用而成为本标准的条款 凡是注日期的引用文件 其随后所 有的修改单 不包括勘误的内容 或修订版均不适用于本标准 然而 鼓励根据本标准达成协议的 各方研究是否可使用这些文件的最新版本 凡是不注日期的引用文件 其最新版本适用于本标准    [1]3GPP TS 29.198-1 Open Service Access; Application Programming  Interface;Part1:Overview.  [2]3GPP TS 22.127  Stage 1 Service Requirement for the Open Service  Access(OSA)(Release 4)   [3]3GPP TS 23.127  Virtual Home Environment(Release 4)   [4]3GPP2  S.R0019(Location-Based Services System) Stage 1 Desciption  [5] ANSI TIA/EIA-664 Cellular Features Description  [6] TIA/EIA J-STD-036 Wireless Enhanced Emergency Services Phase

II  [7] PN-4747 Location Services Enhancements  [8] PN-4818 Wireless Intelligent Network Capabilities For Location Based Services  [9] 开放业务接入技术规范 框架部分   [10] 无线定位业务应用编程接口 API IDL 描述   
5 /5
无线定位业务应用编程接口  
API
技术规范
3 缩约语API  BS CDMA HE  HE-VASP  HLR  IDL  MPC MS  MSC  OSA  PSE PDE SCF SCP VASP VHE VLR Application Programming Interface  Base Station Code Division Multiple Access Home Environment Home Environment Value Added Service Provider   Home Location Register   Interface Description Language  Mobile Postion Center Mobile Station  Mobile Switching Centre Open Service Access Personal Service Environment Position Determining Entity Service Capability Feature Service Control Point Value Added Service Provider Virtual Home Environment Visited Location Register 应用程序接口  基站  码分多址 归属环境  归属环境增值业务提供者  归属位置寄存器  接口描述语言  移动定位中心 移动台  移动交换中心  开放业务接入  个人业务环境  定位实体 业务能力特征  业务控制点  增值业务提供者  虚拟归属环境  拜访位置寄存器 
6 /6
无线定位业务应用编程接口
API
技术规范
4 L1 接口说明根据 PN4747 协议 接口 如图 4-1 所示 L1 接口是 CDMA 移动定位中心 MPC 与定位服务客户机 LCS Client 之间的
MSC E MS Um BS A
PDE E12 MSC C B
E5 E3 Ai
MPC L3 PSTN Di
L1
LCS Client
MPC ISDN L2
Q
AC
H
HLR N
D
VLR
SME
M
SME
M
MC
M
MC
注 AC 鉴权中心 BS 基站 HLR 归属位置寄存器 ISDN 综合业务数字网 MC 短消息中心 PDE 定位实体 LCS Client LCS 客户机
MS 移动台 MSC 移动交换中心 PSTN 公用交换电话网 VLR 拜访位置寄存器 SME 短消息实体 MPC 移动定位中心
图4 - 1   无线定位业务网络参考建模  本规范定义的 L1 应用编程接口 API 利用开放业务接入的架构来提供业务 当移动通讯网络 向 CDMA2000 演进时 可以最大限度地避免网络的演进对原有业务和新业务的冲击和影响
     
7 /7
无线定位业务应用编程接口
API
技术规范
5 移动性 SCF下面的章节描述了移动性业务能力特征(SCF)的各个方面  顺序如下 -  业务流程图 给读者一个如何实现移动性业务SCF的例子    -  -  -  态和转移 接口类层次图 移动性接口类 说明了移动性业务SCF接口类之间的关系 详细描述了每个移动性业务SCF

接口类       
状态转移图 描述了发生在移动性业务SCF中的状态转移 在这一部分 不仅定义了状 而且还涉及接口规范中定义的方法或下层网络中导致状态转移的事件   请注意 某些数据类型
-  数据定义 详细描述了与接口类中方法相关的数据类型的扩展 也被用于其它方法和接口类 因此在本规范公共数据类型中定义   
8 /8
无线定位业务应用编程接口  
API
技术规范
6 业务流程图6.1 用户定位业务流程图
6.1.1
用户位置查询 – 触发请求
下面的流程图给出了一个应用 Application 如何向用户定位业务(User Location service) 请求触发式位置报告的例子 当用户位置变化时 业务将其报告给应用  
: IpAppTriggeredUserLocation
: IpTriggeredUserLocation )
1: triggeredLocationReportingStartReq( 2: triggeredLocationReport( )
3: triggeredLocationReport( ) New reports are sent until the triggered reporting is stopped 4: triggeredLocationReportingStop( )
     1 2 3 4 应用使用此消息向业务申请一个或多个用户触发式位置报告 当设置的触发条件满足时 业务使用此消息将相关用户的位置信息传递给它的回调对象 重复第 2 步 直到应用请求取消触发式位置报告(参见下一消息) 应用请求取消触发式位置报告
6.1.2
用户位置查询 – 定期请求  
下面的流程图给出了一个应用如何向用户定位业务请求定期位置报告的例子
9 /9
无线定位业务应用编程接口
API
技术规范
: IpAppUserLocation 1: periodicLocationReportingStartReq(
: IpUserLocation )
2: periodicLocationReport( ) 3: periodicLocationReport( ) New reports are sent until the periodic reporting is stopped 4: periodicLocationReportingStop( )
    1 2 3 4 应用使用此消息向业务请求一个或几个用户的定期位置报告          业务使用此消息将一个或几个用户的位置信息传递给它的回调对象 业务按规定的时间间隔重复第2步
直到应用请求取消定期位置报告(参见下一消息)  
应用使用此消息请求取消定期位置报告
6.1.3
用户位置查询 – 参数错误当应用向用户定位业务请求一个位
下面的流程图给出了用户位置查询中处理参数错误的例子 置报告时 业务在参数中至少检测到了一个错误 对于     extendedLocationReportReq     periodicLocationReportingStartReq   消息的情况类似 因此并未一一列出  
: IpAppUserLocation 1: locationReportReq( The scenarios for: · extendedLocationReport_Req · periodicLocationReportingStart_Req are similar and therefore not shown. )
: IpUserLocation
  1 应用使用此消息

向业务请求一个或几个用户的位置报告 但业务返回一个错误 请求被终止 执行   
10 / 10
无线定位业务应用编程接口
API
技术规范
6.1.4
用户位置查询 – 网络错误当应用向用户定位业务请求一个位
下面的流程图给出了用户位置查询中处理参数错误的例子 置报告时 发生了与网络有关的错误 对于     extendedLocationReportReq     periodicLocationReportingStartReq   消息的情况类似   因此并未一一列出  
: IpAppUserLocation 1: locationReportReq( )
: IpUserLocation
2: locationReportErr( )
The scenarios for: · extendedLocationReport_Req · periodicLocationReportingStart_Req are similar and therefore not shown. 1 2 应用使用此消息向业务请求一个或几个用户的位置信息报告 在执行请求时 业务发现了与网络有关的错误      
 
并将这些信息传递给它的回调对象
6.1.5
用户位置查询 – 交互式请求 
下面的流程图给出了一个应用如何向用户定位业务请求一个位置报告的例子 : IpAppUserLocation 1: locationReportReq( 2: locationReportRes( ) )
: IpUserLocation
  1 2 应用使用此消息向业务请求一个或几个用户的位置信息报告      
业务使用此消息将一个或几个用户请求结果传递给它的回调对象
11 / 11
无线定位业务应用编程接口
API
技术规范
6.2 基于网络的用户定位业务流程图
6.2.1
基于网络的用户定位查询 – 触发请求当
下面的流程图给出了一个应用如何向基于网络的用户定位业务请求触发式位置报告的例子 用户位置变化时 业务将其位置信息报告给应用  
: IpAppUserLocationNetwork
: IpUserLocationNetwork
1: triggeredLocationReportingStartReq(
)
2: triggeredLocationReport( )
3: triggeredLocationReport( ) New reports are sent until the triggered reporting is stopped 4: triggeredLocationReportingStop( )  1 2 3 4 应用使用此消息向业务请求一个或几个用户的触发式位置报告 当触发条件满足时 重复第2步        
业务使用此该消息将相关用户的位置信息传递给它的回调对象
直到应用请求取消触发式位置报告(参见下一个消息)   
应用使用此消息向业务请求取消触发式位置报告
6.2.2
基于网络的用户定位查询 – 定期请求 
下面的流程图给出了一个应用如何向基于网络的用户定位业务请求定期位置报告的例子
12 / 12
无线定位业务应用编程接口: IpAppUserLocationlNetw
API
技术规范
: IpUserLocationNetwl
1: periodicLocationReportingStartReq(
)
2: periodicLocationReport( )
3: periodicLocationReport( ) New reports are sent until the periodic reporting is stopped 4: periodicLocationReport

ingStop( )
  1 2 3 4 应用使用此消息向业务请求一个或几个用户的定期位置报告          业务使用此消息将一个或几个用户的位置信息传递给它的回调对象 业务按规定的时间间隔重复第2步
直到应用请求取消定期位置报告(参见下一个消息)   
应用使用此消息向业务请求取消定期位置报告
6.2.3
基于网络的用户定位查询 – 参数错误
下面的流程图给出了基于网络的用户定位查询中处理参数错误的例子 当应用向基于网络的用 户定位业务请求一个位置报告时 业务在参数中至少检测到了一个错误 对于      periodicLocationReportingStartReq  消息的情况类似 因此并未列出  
: IpAppUserLocationNetwork
: IpUserLocationNetwork
1: locationReportReq(
)
The scenarios for: · periodicLocationReportingStart_Req are similar and therefore not shown.  误
 
1 应用使用此消息向业务请求一个或几个用户的位置信息报告 但业务在参数中发现了一个错 请求执行被终止   
6.2.4
基于网络的用户定位查询 – 网络错误发生了与网
下面的流程图给出了当应用向基于网络的用户定位业务请求一个位置信息报告时 络相关错误的例子 对于  
13 / 13
无线定位业务应用编程接口   periodicLocationReportingStartReq   消息的情况类似 因此并未列出  
API
技术规范
: IpAppUserLocationNetwor 1: locationReportReq( 2: locationReportErr( ) )
: IpUserLocationNetwor
The scenarios for: ·extendedLocationReport_Req ·periodicLocationReportingStart_Req are similar and therefore not shown.  1 应用使用此消息向业务请求一个或几个用户的位置信息报告   
2 业务在执行请求时 发生了与网络有关的错误 业务使用此消息将错误信息传递给它的回调 对象   
6.2.5
基于网络的用户定位查询 – 交互式请求 
下面的流程图给出了一个应用如何向基于网络的用户定位业务请求一个位置报告的例子
: IpAppUserLocationNetwor 1: locationReportReq( )
: IpUserLocationNetwor
2: locationReportRes( )
  1 2 应用使用此消息向业务请求一个或几个用户的位置信息报告      
业务使用此消息将一个或几个用户请求结果传递给它的回调对象
6.3 用户状态业务流程图
6.3.1
触发式状态信息报告当用户的
下面的流程图给出了一个应用如何向状态位置业务请求触发式状态信息报告的例子 状态改变时 业务将其状态信息报告给应用   
14 / 14
无线定位业务应用编程接口: IpAppUserStatus : IpUserStatus
API
技术规范
1: triggeredStatusReportingStartReq(
)
2: triggeredStatusReport( )
3: triggeredStatusRepo

rt( ) New reports are sent until the triggered reporting is stopped 4: triggeredStatusReportingStop( )
  1 2 3 4 应用使用此消息向业务请求一个或几个用户的触发式状态信息报告 当一个指定用户的状态改变时 重复第2步      
业务使用此消息将用户状态传递给它的回调对象      
直到应用请求取消触发式状态信息报告(参见下一个消息)
应用使用此消息向业务请求取消触发式状态信息报告
6.3.2
交互式请求参数错误
下面的流程图给出了处理参数错误的例子 当应用向用户状态业务请求一个状态信息报告时 业务检测到了参数错误 并调用了一个处理错误的方法  
: IpAppUserStatus 1: statusReportReq( The method is returning an error code. )
: IpUserStatus
   
6.3.3
交互式请求网络错误发生了与网络相关错误的例子  
下面的流程图给出了当应用向业务请求用户状态信息报告时
15 / 15
无线定位业务应用编程接口
API
技术规范
: IpAppUserStatus 1: statusReportReq( 2: statusReportErr( ) An error has occured while processing the request and an error method is called. )
: IpUserStatus
   
6.3.4
交互式请求  
下面的流程图给出了一个应用如何向用户状态业务请求一个状态信息报告的例子
: IpAppUserStatus 1: statusReportReq( 2: statusReportRes( ) )
: IpUserStatus
  1 2 应用使用此消息向业务请求一个或几个用户的状态信息报告 业务使用此消息将请求结果传递给业务的回调对象      
16 / 16
无线定位业务应用编程接口  
API
技术规范
7 接口类层次图7.1 用户定位接口类层次图下图给出了用户定位业务接口类之间的关系图 IpTriggeredUserLocation 继 承 IpUserLocation IpAppTriggeredUserLocation 继承 IpAppUserLocation   
17 / 17
无线定位业务应用编程接口
API
技术规范
<> IpAppTriggeredUserLocation (from ul) triggeredLocationReport() triggeredLocationReportErr()
<> IpAppUserLocation (from ul) locationReportRes() locationReportErr() extendedLocationReportRes() extendedLocationReportErr() periodicLocationReport() periodicLocationReportErr()
<> IpUserLocation (from ul) locationReportReq() extendedLocationReportReq() periodicLocationReportingStartReq() periodicLocationReportingStop()
<> IpTriggeredUserLocation (from ul) triggeredLocationReportingStartReq() triggeredLocationReportingStop()  图7 - 1   用户定位业务接口类层次图 
7.2 基于网络的用户定位业务接口类层次图下图给出了基于网络的用户定位业务接口类之间的关系   
18 / 18
无线定位业务应用编程接口
API
技术规范
<<

Interface>> IpAppUserLocationNetwork (from uln) locationReportRes() locationReportErr() periodicLocationReport() periodicLocationReportErr() triggeredLocationReport() triggeredLocationReportEr...
<> IpUserLocationNetwork (from uln) locationReportReq() periodicLocationReportingStartReq() periodicLocationReportingStop() triggeredLocationReportingStartRe... triggeredLocationReportingStop()图7 - 2 基于网络的用户定位接口类层次图 
  
7.3 用户状态接口类层次图下图给出了用户状态业务接口类之间的关系图  
19 / 19
无线定位业务应用编程接口
API
技术规范
<> IpAppUserStatus (from us) statusReportRes() statusReportErr() triggeredStatusReport() triggeredStatusReportErr()
<> IpUserStatus (from us) statusReportReq() triggeredStatusReportingStartReq() triggeredStatusReportingStop()图7 - 3     用户状态接口类层次图 
 
20 / 20
无线定位业务应用编程接口  
API
技术规范
8 业务接口规范8.1 接口规范格式本节定义与 API 规范相关的接口 以下是接口规范的一般格式描述   方法和参数格式 对接口类的描述采用统一建模语言(UML)
8.1.1
接口类
这部分给出了接口类的 UML 描述 包括此接口类支持的方法 相关参数及其类型 支持客户应 用的业务 Service 和框架(Framework)接 口 类 由 Ip<name>标识 用于回调的应用接口类由 IpApp<name>标识 对于业务和框架间的接口 业务接口典型地由 IpSvc <name>标识 而框架接口 由 IpFw<name>标识  
8.1.2
方法描述
这部分将描述接口类中的每个 API 方法 如果 API 方法返回一个类型为 TpResult 值 则是对调 用执行成功或失败的标识 不允许取其它值   在 API 中 分同步调用和和异步调用两类方法 对于一个请求而言 异步调用方法用一个 Req 后缀标识 如果对该请求存在对应的异步方法 则分别用 Res 和 Err 后缀标识返回结果和错 误 为了处理响应和报告 应用或业务开发商必须实现相关的 IpApp<name>或 IpSvc<name>接口以提 供回调机制  
8.1.3
参数描述
这部分将描述每个方法的参数及其可能取值 带有 in  描述的参数表示在调用此方法时应给 该参数赋值 那些带有 out  描述的参数在调用此方法后必须返回执行结果  
8.1.4
状态模型则在实现此接口对象时应给出其状态模型  
如果一个接口对象与状态相关
21 / 21
无线定位业务应用编程接口
API
技术规范
8.2 基本接口
8.2.1
IpInterface 接口类
所有应用 application 框架(framework)和业务

 (service)  接口均继承下面的接口 此 API 基本接口不提供任何额外的方法  <<Interface>>  IpInterface     
8.3 业务接口
8.3.1
概览
业务接口 Service Interfacs 提供下层网络能力的接口   诸如移动性(mobility) 呼叫控 制 call control 用户交互(user interaction) 消息 messaging 以及互通性管理 connectivity  management   由业务实现的接口被标记为 业务接口 与之对应的由应用实现的接口(如 API 回调)被标记为 应用接口  
8.4 一般业务接口
8.4.1
I p S e r v i c e 接口类  <<Interface>>  IpService 
继承自 IpInterface   所有业务接口均继承下面的接口
  setCallback (appInterface in IpInterfaceRef) void  in TpSessionID) void 
setCallbackWithSessionID (appInterface
in IpInterfaceRef, sessionID
方法  setCallback() 此方法提供业务回调应用接口的地址 对于须使用对话标识 SessionID 参数的情形 禁止调22 / 22
无线定位业务应用编程接口 用此方法  
API
技术规范
参数 appInterface in IpInterfaceRef此参数提供业务回调应用接口的地址  
异常 TpCommonExceptions
方法  setCallbackWithSessionID() 此方法提供与对话标识 session ID 参数相关的业务回调应用接口的地址 标识 SessionID 参数的情形 禁止调用此方法   对于不使用对话
参数 appInterface in IpInterfaceRef此参数提供业务回调应用接口的地址    
sessionID in TpSessionID此参数标识业务回调应用接口的对话
异常 TpCommonExceptions
23 / 23
无线定位业务应用编程接口  
API
技术规范
9 移动性接口类9.1 用户定位接口类用户定位 (UL)  业务为用户提供了一般的地理位置信息服务 UL 具备允许应用 Application 获得用户地理位置以及固定用户 移动用户和基于 IP 的电话用户状态信息的能力    基于网络的用户定位 ULN 业务是 UL 业务的一种补充 用以提供与网络相关的信息 也有一 些专门的功能处理用户紧急定位业务 ULE User Location Emergency 

中的紧急呼叫    UL 业务提供 IpUserLocation 和 IpTriggeredUserLocation 两个接口类 接口类中的多数方法 是异步的 在调用这些方法时 不必为了等待执行结果而锁定一个线程 在这种情况下 与同步方 法相比 客户机就可以处理更多的异步调用 为了对业务的请求做出响应和报告用户的位置信息 开发商必须在应用侧实现 IpAppUserLocation 和 IpAppTriggeredUserLocation 接口类 以提供业 务的回调机制   当使用定期或触发式位置信息报告请求时 错误报告分两种 一是与请求中单个用户有关的错 误报告 二是涉及请求中所有用户时 调用相关的错误处理方法  
9.1.1
IpUserLocation 接口类
继承自 IpService   此接口是用户定位业务 User Location Service 的 业务管理者 接口   用户定位接口向用户定位业务提供管理功能 应用开发商可以调用此接口来获得用户的地理位 置信息   <<Interface>>  IpUserLocation    locationReportReq (appLocation in IpAppUserLocationRef, users in TpAddressSet) TpSessionID 
extendedLocationReportReq (appLocation in IpAppUserLocationRef, users in TpAddressSet, request in TpLocationRequest) TpSessionID  periodicLocationReportingStartReq (appLocation in IpAppUserLocationRef, users in TpAddressSet,  request in TpLocationRequest, reportingInterval in TpDuration) TpSessionID  periodicLocationReportingStop (stopRequest in TpMobilityStopAssignmentData) void 
方法  locationReportReq() 应用使用此方法向业务请求报告一个或几个用户的位置信息 对调用此方法可能产生的异常说明如下   P_NO_CALLBACK_ADDRESS_SET 拒绝执行此方法 因为方法中没有设置回调地址  
2

4 / 24
无线定位业务应用编程接口 P_RESOURCES_UNAVAILABLE  所要求的网络资源不可用 应用可以尝试在稍后调用此方法 P_UNKNOWN_SUBSCRIBER 终端用户未签约此应用 P_APPLICATION_NOT_ACTIVATED 终端用户已去激活此应用 P_INFORMATION_NOT_AVAILABLE 不允许查询此终端用户位置信息   
API
技术规范
参数 appLocation in IpAppUserLocationRef此参数是用户定位业务回调的应用接口地址  
users in TpAddressSet此参数标识请求位置信息报告的用户    
返回值 TpSessionID  
异常 TpCommonExceptions, P_APPLICATION_NOT_ACTIVATED, P_INFORMATION_NOT_AVAILABLE, P_UNKNOWN_SUBSCRIBER 
方法  extendedLocationReportReq() 应用使用此方法向业务请求报告一个或几个用户的高级位置信息 对调用此方法可能产生的异常说明如下   P_NO_CALLBACK_ADDRESS_SET 拒绝执行此方法 因为方法中没有设置回调地址 P_RESOURCES_UNAVAILABLE  所要求的网络资源不可用 应用可以尝试在稍后调用此方法 P_UNKNOWN_SUBSCRIBER 终端用户未签约此应用 P_APPLICATION_NOT_ACTIVATED 终端用户已去激活此应用 P_INFORMATION_NOT_AVAILABLE 不允许查询此终端用户位置信息        
参数   appLocation in IpAppUserLocationRef此参数是用户定位业务回调的应用接口地址  
users in TpAddressSet此参数标识请求位置信息报告的用户  25 / 25
无线定位业务应用编程接口
API
技术规范
request in TpLocationRequest此参数标识对定位业务的额外请求 定位类型 (response time)和优先级(priority)     location type 精度(accuracy) 响应时间
返回值 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 
方法  periodicLocationReportingStartReq() 应用使用此方法向业务请求定期报告一个或几个用户的位置信息 对调用此方法可能产生的异常说明如下   P_NO_CALLBACK_ADDRESS_SET 拒绝执行此方法 因为方法中没有设置回调地址 P_RESOURCES_UNAVAILABLE  所要求的网络资源不可用 应用可以尝试在稍后调用此方法 P_UNKNOWN_SUBSCRIBER 终端用户未签约此应用 P_APPLICATION_NOT_ACTIVATED 终端用户已去激活此应用 P_INFORMATION_NOT_AVAILABLE 不允许查询此终端用户位置信息       
参数   appLocation in IpAppUserLocationRef此参数是用户定位业务回调的应用接口地址  
use

rs in TpAddressSet此参数标识请求位置信息报告的用户   location type 精度(accuracy) 响应时间
request in TpLocationRequest此参数标识对定位业务的额外请求 定位类型 (response time)和优先级(priority)   
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 
方法  periodicLocationReportingStop() 应用使用此方法向业务请求取消一个或几个用户的位置信息报告 对调用此方法可能产生的异常说明如下    P_INVALID_ASSIGNMENT_ID  参数 assignmentID 无效     
参数 stopRequest in TpMobilityStopAssignmentData此参数说明如何取消指定的位置信息报告 即对全部用户还是对部分用户  
异常 TpCommonExceptions, P_INVALID_ASSIGNMENT_ID 
9.1.2
IpAppUserLocation 接口类业务使用此接口对应用的用户位置信息请求做出
继承自 IpInterface   用户位置的应用接口由客户应用开发商实现 响应   
<<Interface>>  IpAppUserLocation    LocationReportRes (assignmentId locationReportErr (assignmentId TpMobilityDiagnostic) void  in TpSessionID, locations in TpSessionID, cause in TpUserLocationSet) void  in 
in TpMobilityError, diagnostic in 
extendedLocationReportRes (assignmentId TpUserLocationExtendedSet) void  extendedLocationReportErr (assignmentId in TpMobilityDiagnostic) void  periodicLocationReport (assignmentId void 
in TpSessionID, locations in TpSessionID, cause
in TpM

obilityError, diagnostic in TpUserLocationExtendedSet) in TpMobilityError, diagnostic
in TpSessionID, locations in TpSessionID, cause
periodicLocationReportErr (assignmentId in TpMobilityDiagnostic) void 
方法  locationReportRes() 业务使用此方法向应用报告一个或几个用户的位置信息  27 / 27
无线定位业务应用编程接口
API
技术规范
参数 assignmentId in TpSessionID此参数标识指定的位置报告请求    
locations in TpUserLocationSet此参数表示一个或几个用户的位置信息  
方法  locationReportErr() 业务使用此方法向应用指示所请求的位置报告失败   
参数 assignmentId in TpSessionID此参数标识指定的位置报告请求 此参数标识导致故障的原因      
cause in TpMobilityError diagnostic in TpMobilityDiagnostic此参数标识导致故障的额外信息  
方法  extendedLocationReportRes() 业务使用此方法向应用报告一个或几个用户的扩展位置信息   
参数 assignmentId in TpSessionID此参数标识指定的位置报告请求    
locations in TpUserLocationExtendedSet此参数标识一个或几个用户的扩展位置信息  
方法  extendedLocationReportErr() 业务使用此方法向应用指示所请求的位置报告失败     
参数   assignmentId in TpSessionID此参数标识指定的位置报告请求 此参数标识导致故障的原因      
cause in TpMobilityError diagnostic in TpMobilityDiagnostic此参数标识导致故障的额外信息    
28 / 28
无线定位业务应用编程接口
API
技术规范
方法  periodicLocationReport() 业务使用此方法向应用定期报告一个或几个用户的位置信息
参数 assignmentId in TpSessionID此参数标识指定的定期位置信息报告请求 此参数表示一个或几个用户的位置信息  
locations in TpUserLocationExtendedSet
方法  periodicLocationReportErr() 业务使用此方法向应用指示一个请求的定期位置报告失败 periodicLocationReport()方法中给出    请注意 仅涉及单个用户的错误在
参数 assignmentId in TpSessionID此参数标识已失败的定期位置报告请求  

cause in TpMobilityError此参数说明导致故障的原因    
diagnostic in TpMobilityDiagnostic此参数说明导致故障的额外信息
9.1.3
IpTriggeredUserLocation 接口类
继承自 IpUserLocation   此接口可以被用作用户定位 User Location 业务的扩展   IpTriggeredUserLocation 接口提供按条件触发的用户位置功能 应用开发商可以使用此接口请求 由位置变化触发的用户位置报告   <<Interface>>  IpTriggeredUserLocation    triggeredLocationReportingStartReq (appLocation in IpAppTriggeredUserLocationRef, users in  TpAddressSet, request in TpLocationRequest, triggers in TpLocationTriggerSet) TpSessionID  triggeredLocationReportingStop (stopRequest in TpMobilityStopAssignmentData) void 
方法  triggeredLocationReportingStartReq() 应用使用此方法向业务请求当用户位置变化时报告用户的位置信息(报告由位置变化触发引 起)   
参数 appLocation in IpAppTriggeredUserLocationRef此参数标识触发式用户位置业务回调的应用接口  29 / 29
无线定位业务应用编程接口
API
技术规范
users in TpAddressSet此参数标识请求位置信息报告的用户 此参数标识请求的位置类型 此参数设置触发条件     精度   响应时间和优先权  
request in TpLocationRequest triggers in TpLocationTriggerSet
返回值 TpSessionID
异常 TpCommonExceptions,P_REQUESTED_ACCURACY_CANNOT_BE_DELIVERED,P_REQ UESTED_RESPONSE_TIME_CANNOT_BE_DELIVERED,P_TRIGGER_CONDITIONS_NOT_SU BSCRIBED,P_UNKNOWN_SUBSCRIBER,P_APPLICATION_NOT_ACTIVATED,P_INFORMAT ION_NOT_AVAILABLE 
方法  triggeredLocationReportingStop() 应用使用此方法向业务请求取消由发送位置变化引起的用户位置信息报告   
参数 stopRequest in TpMobilityStopAssignmentData此参数指示如何取消用户位置信息报告 即涉及全部用户还是部分用户  
异常 TpCommonExceptions, P_INVALID_ASSIGNMENT_ID 
9.1.4
IpAppTriggeredUserLocation 接口类
继承自 IpAppUserLocation   此 接 口 必 须 被 用 作 用 户 位 置 User Location 的 一

个 专 门 的 版 本 如 果 业 务 提 供 lpTriggeredUserLocation 接口 则应用需要具备对应的 lpAPPTriggeredUserLocation 接口   此接口应由应用开发商实现 用于处理用户位置变化而触发的位置信息报告  <<Interface>>  IpAppTriggeredUserLocation    triggeredLocationReport (assignmentId in TpSessionID, location criterion in TpLocationTriggerCriteria) void  in TpUserLocationExtended, 
triggeredLocationReportErr (assignmentId in TpSessionID, cause in TpMobilityError, diagnostic in TpMobilityDiagnostic) void 
30 / 30
无线定位业务应用编程接口
API
技术规范
方法  triggeredLocationReport() 业务使用此方法向应用发送由用户位置变化触发的用户位置信息报告   
参数 assignmentId in TpSessionID此参数标识用户位置报告请求 此参数标明用户的位置      
location in TpUserLocationExtended criterion in TpLocationTriggerCriteria此参数设置用户位置报告的触发条件
方法  triggeredLocationReportErr() 业务使用此方法向应用指示不能完成请求的触发式用户位置信息报告 户的错误在普通的 triggeredLocationReport()消息中给出   请注意 仅涉及单个用
参数 assignmentId in TpSessionID此参数标识已失败的用户位置信息报告请求  
cause in TpMobilityError此参数标识导致故障的原因    
diagnostic in TpMobilityDiagnostic此参数标明导致故障的额外信息
9.2 基于网络的用户定位接口类ULN User Location Network 主要提供基于网络的用户定位信息 要获取用户的地理坐标可 以借助普通的用户定位业务 User Location Service   使用 ULN 提供的功能 一个应用编程者可以获得移动电话用户的 VLR 号码 位置区标识 LAI Location Area Identification 和全球小区号码 CGI:Cell Global Identification 以及其它 移动电话专有的

本文来源:https://www.bwwdw.com/article/ggzq.html

Top