YD/T 2940-2015
基本信息
标准号： YD/T 2940-2015
中文名称：基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)终端状态
标准类别：通信行业标准(YD)
标准状态：现行
出版语种：简体中文
下载格式：.zip .pdf
下载大小：24445272
相关标签： 基于 表述 状态 转移 技术 业务 能力 开放 应用 程序接口 终端
标准分类号
关联标准
出版信息
相关单位信息
标准简介
YD/T 2940-2015.RESTful based service capability open API-Terminal status.
1范围
YD/T 2940规定了基于表述性状态转移(REST) 技术的终端状态的API接口定义、资源详细规范，以及错误定义。
YD/T 2940适用于提供终端状态能力开放的应用程序接口(API)。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。
IETF RFC2616 超文本传输协议(Hypertext Transfer Protocol-HTTP)
OMA OMA-RD-Autho4API_ 10 网络API授 权架构(Authorization Framework for Network APIs)
OMA OMA-TS-REST_ NetAPI_ 基于表述性状态转移(REST)技术的网络应用程序接口(API)
Common 通用定义(Common definitions for RESTful Network APIs)
OMA OMA-TS-REST_ SUP_ 基于表述性状态转移(REST) 技术的终端状态XML结构网络应用
3术语、定义和缩略语
3.1术语和定义
下列术语和定义适用于本文件。
3.1.1
客户端用于通知的 URL Client-Side Notification URL
一个由客户端公开的HTTP URL,它可以接收通知,可以用于客户端订阅通知。
3.1.2
通知信道 Notification Channel
一个在客户端请求的基础上创建的通道,用于从服务器向客户端发送通知。通道表示为一个资源，并通过指定的交付机制，为服务器发布和客户端接收通知提供方式。
1范围
YD/T 2940规定了基于表述性状态转移(REST) 技术的终端状态的API接口定义、资源详细规范，以及错误定义。
YD/T 2940适用于提供终端状态能力开放的应用程序接口(API)。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。
IETF RFC2616 超文本传输协议(Hypertext Transfer Protocol-HTTP)
OMA OMA-RD-Autho4API_ 10 网络API授 权架构(Authorization Framework for Network APIs)
OMA OMA-TS-REST_ NetAPI_ 基于表述性状态转移(REST)技术的网络应用程序接口(API)
Common 通用定义(Common definitions for RESTful Network APIs)
OMA OMA-TS-REST_ SUP_ 基于表述性状态转移(REST) 技术的终端状态XML结构网络应用
3术语、定义和缩略语
3.1术语和定义
下列术语和定义适用于本文件。
3.1.1
客户端用于通知的 URL Client-Side Notification URL
一个由客户端公开的HTTP URL,它可以接收通知,可以用于客户端订阅通知。
3.1.2
通知信道 Notification Channel
一个在客户端请求的基础上创建的通道,用于从服务器向客户端发送通知。通道表示为一个资源，并通过指定的交付机制，为服务器发布和客户端接收通知提供方式。
标准图片预览
标准内容
ICS33.040
中华人民共和国通信行业标准
YD/T2940-2015
基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端状态REsTfulbasedservicecapabilityopenAPl--Terminal status(OMA-TS-RESTNetAPITerminalStatus-V10-20121127-DRESTfulNetworkAPIforTerminalStatus，NEQ2015-07-14发布
2015-10-01实施
中华人民共和国工业和信息化部发布前
范围·
2规范性引用文件
3术语、定义和缩略语·
3.1术语和定义
3.2缩略语·
4终端状态API定义
功能的概述
资源概述
数据类型
流程图·
5资源详细规范
资源：终端状态集合·
资源：终端可访问性状态
资源：终端漫游状态
资源：终端连接类型
资源：状态集合变更通知订阅·资源：个人状态集合变更通知订阅资源：可访问性状态变更通知订阅·目
资源：个人可访问性状态变更通知订阅·资源：漫游状态变更通知订阅
资源：个人漫游状态变更通知订阅5.11
资源：连接类型变更通知订阅·5.12资源：个人连接类型变更通知订阅5.13资源：客户端的终端状态变更通知6错误定义·
服务异常·
6.2策略异常·
附录A（规范性附录）应用程序/x-www-form-urlencodedPOST操作请求格式·附录B（规范性附录）授权相关
YD/T2940-2015
··62
YD/T2940-2015
本标准是“基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）”系列标准之一，该系列标准的结构及名称预计如下：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）短消息和多媒体消息业务部分；
一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）点击拨号；一一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端状态；一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端能力信息：一一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）微博业务一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）搜索业务：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）地址本：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）文件传输业务：：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）定位业务：一一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）状态呈现业务：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）聊天业务一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）用户信息业务：一一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）支付业务；一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（APD）视频共享：基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）图片共享：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）移动互联网用户上下文感知业务。
本标准按照GB/T1.1-2009给出的规则起草。本标准使用重新起草法参考OMA-TS-RESTNetAPI_TerminalStatus-V10-20121127-D《基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端状态》编制，与OMA-TSREST_NetAPI_TerminalStatus-V1_0-20121127-D的一致性程度为非等效，主要做了如下编辑性修改：一删除了第4章“介绍”：
一删除了附录A（资料性附录）“变更历史”；一删除了附录B（规范性附录）“应用程序/x-www-form-urlencodedPOST操作请求格式”；一删除了附录D（资料性附录）“JSON实例”；删除了附录E（资料性附录）“ParlayX操作映射”；删除了附录F（资料性附录）“轻量级资源”。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。II
本标准由中国通信标准化协会提出并归口。本标准起草单位：北京邮电大学、中国信息通信研究院。YD/T2940-2015
本标准主要起草人：张勇、滕颖蕾、宋梅、鲍叙言、程刚、崔媛媛、陈国利、陈娟、韩滢、陈桦、宋朝阳、杨明、成晨、封龙、张雅君、杨露、卫海波、方一鸣、李沸乐、王东安。
1范围
基于表述性状态转移（REST）技术的业务能力开放应用程序接口（APD）终端状态YD/T2940-2015
本标准规定了基于表述性状态转移（REST）技术的终端状态的API接口定义、资源详细规范，以及错误定义。
本标准适用于提供终端状态能力开放的应用程序接口（API）。2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。IETFRFC2616
OMAOMA-RD-Autho4API10
OMAOMA-TS-REST_NetAPI
Common
OMAOMA-TS-REST_SUP
TerminalStatus
OMAOMA-TS-RESTNetAPI
NotificationChannel
W3CURLENC
W3CXMLSchemal
W3C XMLSchema2
ITU-TE.212
3术语、定义和缩略语
3.1术语和定义
下列术语和定义适用于本文件。3.1.1
超文本传输协议(HypertextTransferProtocol-HTTP)网络API授权架构(AuthorizationFrameworkforNetworkAPIs）基于表述性状态转移（REST）技术的网络应用程序接口（API）通用定义（CommondefinitionsforRESTfulNetworkAPIs）基于表述性状态转移（REST）技术的终端状态XML结构网络应用程序接（API）XMLstructureforRESTfulNetworkAPITerminalStatus)
基于表述性状态转移（REST）技术的通知通道网络应用程序接口(API)(NotificationChannelforRESTfulNetworkAPIs)超文本标记语言4.01规范，17.13.4节：表单内容类型（HTML4.01Specification, Section 17.13.4Form content types)可扩展标识语言架构第1部分：结构（第二版）(XMLSchemaPart1: Structures Second Edition)可扩展标识语言架构第2部分：数据类型（第二版）（XMLSchemaPart 2: Datatypes Second Edition)公开网络和订阅的国际识别计划（Theinternationalidentificationplan for public networks and subscriptions)客户端用于通知的URLClient-SideNotificationURL一个由客户端公开的HTTPURL，它可以接收通知，可以用于客户端订阅通知。3.1.2
通知信道NotificationChannel
一个在客户端请求的基础上创建的通道，用于从服务器向客户端发送通知。通道表示为一个资源，并通过指定的交付机制，为服务器发布和客户端接收通知提供方式。一
YD/T2940-2015
通知服务器NotificationServer一个可以创建和维护通知信道（NotificationChannels）的服务器。3.1.4
服务器端用于通知的URLServer-SideNotificationURL一个由通知服务器（NotificationServer）公开的HTTPURL。它标识一个客户端可以用于订阅通知的通知信道（NotificationChannel）。3.2缩略语
下列缩略语适用于本文件。
TD-SCDMA
Anonymous Customer ReferenceApplication Programming InterfaceCode Division Multiple AccessEnhancedDataratesforGSMEvolutionGeneral Packet Radio ServiceHyperText Transfer Protocol
High-SpeedDownlinkPacketAccessEvolved High-Speed Packet AccessHigh-Speed Uplink Packet AccessJavaScript Object Notation
Long Term Evolution
MobileCountry orGeographical Area CodesMultipurpose Internet Mail ExtensionsMobile Network Code
MobileNetworkOperator
MobileVirtual Network OperatorOpen MobileAlliance
REpresentational State TransferStatic Conformance RequirementsSession Initiation Protocol
Time Division Synchronous Code Division MultipleAccess
Technical Specification
Uniform Resource Identifier
Uniform Resource Locator
Wideband CodeDivisionMultipleAccessWorldwide Interoperability for Microwave AccessWireless Local Area Network
Extensible Markup Language
XMLSchema Definition
医名用户参考表
应用程序编程接口
码分多址接入
GSM演化的增强型数据速率
通用无线分组业务
超文本传输协议
高速下行分组接入
增强型高速分组接入
高速上行分组接入
JavaScript对象表示法
长期演进
移动城市或地区代码
多用途因特网邮件扩充
移动网络码
移动运营商
移动虚拟网络运营商
开放的移动联盟
表述性状态转移
静态符合性要求
会话初始化协议
时分一同步码分多址接入
技术规范
统一资源标识符
统一资源定位符
宽带码分多址接入
全球微波互联接入
无线局域网
可延伸标记语言
XML模式定义
4终端状态API定义
4.1功能的概无述
YD/T2940-2015
本章介绍了终端状态API的设计，详细介绍了所有资源定义、所有数据结构的定义、所有指定资源的详细操作定义。
第5章的所有例子的信息主体均是XML格式，见附录A。附录B规定了在结合某些授权框架的情况下，如何使用REST风格的终端状态API。4.2资源概述
本节中总结了关于终端状态的RESTful网络API中所用到的所有资源。\apiVersion\URL变量应有\vl\值，表明API对应于这个版本的标准，该变量的语义指定见OMA-TS-REST NetAPI Common。
图1可视化地展示了本标准中定义的资源结构。源树中那些与本标准中定义的HTTP方法关联的节点用固体盒子（实体源）描述。
/serverRoot/terminalstatus/apiVersion)fqueries
/statusCollection
accessibiityStatusO
/roamingStatus
/connectionType
/subscriptions
IstatusCollection
laccessibilityStatus
JroamingStatus C
IconnectionType
图1本标准定义的资源结构
Ksubscriptionld)
(subscriptionld)
(subscriptionldyO
(subscriptionld)
表1对本标准定义的资源结构做出了具体的描述，表现在数据类型和允许的HTTP方法表1目的：允许客户端检索终端状态集合，终端可访问性状态，漫游状态以及连接类型URL
终端状态集合
BaseURL:
http://(serverRoot)/termi
nalstatus/(apiVersion)
/queries/statusCollection
终端可访间性/queries/accessibilityStatus状态
终端漫游状态
/queries/roamingStatus
数据结构
TerminalStatusCollectionListTerminalAccessibilityStatusListTerminalRoamingStatusList
HTTP方法
返回当前可访问性状态，
漫游状态，以及一种或多
种终端连接类型
返回当前一种或多种终
端可访间性状态
返回当前一种或多种终
端漫游状态
DELETE
YD/T2940-2015
Base URL:
http://(serverRoot)/termi
nalstatus/(apiVersion)
终端连接类型
表1（续）
数据结构
/queries /connectionTypeTerminalConnectionTypeList表2表示了允许客户端管理终端状态变更通知的订阅。GET
HTTP方法
POSTDELETE
返回当前一种或多种终
端连接类型
表2目的：允许客户端管理终端状态变更通知的订阅URL
BaseURL:
http://(serverRoot)/termin
alstatus/(apiVersion)
状态集合变更通/subscriptions/status知的订阅
Collection
数据结构
NotificationSubscriptionL
ist（此数据结构适用于
“GET”动作】
StatusCollectionChanges
ubscription（适用于
“POST”动作
common:ResourceReferen
ce（适用于POST应答的
可选项）
个人状态集合变/subscriptions/statusColleStatusCollectionChangesubscription（适用于
更通知的订阅
ction/(subscriptionId)
个人状态变更通/subscriptions/accessibility知的订阅
Status
个人可访间性状/subscriptions/accessibility态变更通知的
Status//subscriptionld?
漫游状态变更通/subscriptions/roaming知的订阅
Status
个人漫游状态变/subscriptions/roaming更通知的订阅
Status/(subscriptionId
“GET”和“PUT”动作】
NotificationSubscriptionL
ist（适用于“GET”动作）
AccessibilityChangeSubsc
ription（适用于“POST”
动作）
common:ResourceReferen
ce（适用于POST应答的
可选项）
返回所有订阅
HTTP方法
返回某个订阅 更新订阅
返回所有订阅
AccessibilityChangeSubsc返回某个订阅更新订阅ription（适用于“GET\
和“PUT”动作】
NotificationSubscriptionL
ist（适用于“GET”动作）
RoamingChangeSubscript
ion（适用于“POST\
动作）
common:ResourceReferen
ce（适用于POST应答的
可选项）
返回所有订阅
t返回某个订阅更新订阅
RoamingChangeSubscript
ion（适用于\GET”和
“PUT”动作）
创建新的
创建新的
创建新的
DELETE
删除某个订阅
删除某个订阅
删除某个订阅
BaseURL:
http://serverRoot//termin
alstatus/(apiVersion)
表2（续）
数据结构
连接类型变更通/subscriptions/connectionNotificationSubscriptionL
返回所有订阅
知的订阅
ist（适用于“GET”动作）
ConnectionChangeSubscri
ption（适用于“POST\
动作）
common:ResourceReferen
ce（适用于POST应答的
可选项）
HTTP方法
个人连接类型变/subscriptions/conncctionConnectionChangeSubscri返回某个订阅更新订阅
更通知的订阅
Type/(subscriptionId)
ption（适用于“GET”和
“PUT”动作）
允许服务器通知客户端关于终端状态的变更见表3。表3目的：允许服务器通知客户端关于终端状态的变更URL
关于终端状态
变更的客户端
BaseURL:
http://(serverRoot)/term
inalstatus/(apiVersion)
(provided by client)
4.3数据类型
4.3.1XML命名空间
数据结构
StatusCollectionChangeNotificationAccessibilityChangeNotificationRoamingChangeNotification
ConnectionChangeNotificationSubscriptionCancellationNotification对TerminalStatus数据类型XML命名空间是：urn:oma:xml:rest:netapi:terminalstatus:1GET
YD/T2940-2015
创建新的
HTTP方法
DELETE
删除某个订阅
DELETE
关于终端状态
变更的通知
“xsd'命名前缀在当前文档中的使用是为了参考在XML架构（见XMLSchemal，见XMLSchema2.）中定义的XML架构数据类型。“common'的命名前缀在当前文档中的使用是为按照在OMA-TS-RESTNetAPICommon中定义的数据类型。命名前缀的使用，例如：“xsd\，并没有语义上的重要性。
在接下来的部分中定义的针对数据结构的XML架构应按照OMA-TS-RESTSUP_TerminalStatus给出。
跟随针对终端状态V1.0版本的RESTful网络的API应使用命名空间urn:oma:xml:rest:netapi:terminalstatus:14.3.2结构
4.2.2.1对后续章节的相关的数据结构说明在4.2.2.2~4.2.2.23中对在终端状态API中使用的数据结构进行了定义，某些结构能够实例化为所谓5
YD/T2940-2015
的根元素。第5章中关于“tel\sip'和\acr\统一标识符方案的陈述，对那些包含了说明用户标识符元素的结构做了申请。
4.2.2.2类型：TerminalStatusCollectionList终端状态集合见表4。
表4终端状态集合
collection
resourceURL
TerminalStatusCollection[1..unbounded]xsd:anyURI免费标准bzxz.net
可选项
收集终端状态集合
自指URL
允许在请求实体中出现名为terminalStatusCollectionList且类型为TerminalStatusCollectionList的根元素。
4.2.2.3类型：TerminalStatusCollection当前终端状态集合见表5。
表5当前终端状态集合
address
accessibility
roaming
connectionType
xsd:anyURI
AccessibilityStatusForCollectionRoamingStatusForCollection
ConnectionTypeForCollection
4.2.2.4类型：AccessibilityStatusForCollection当前终端连接访问状态集合见表6。表6
retrievalStatus
currentAccessibility
homeMccMne
errorInformation
可选项
当前终端连接访问状态集合
可选项
common:RetrievalStatus
RoamingStatus
MobileCountryNetworkCode
common:ServiceError
4.2.2.5类型：RoamingStatusForCollection当前终端漫游状态集合见表7。
状态集合信息适用的终端设备地址(如：sipURIL,'te'URI,acr'URI)终端访问状态
终端漫游状态
终端的连接状态
针对该终端地址的检索状态
终端的访间状态，检索状态=Retrieved时应包含适用于家庭网络的移动网络代码元组当检索状态=Error时应包含，这是错误的原因当前终端漫游状态集合
retrievalStatus
currentRoaming
servingMecMnc
errorlnformation
common:RetrievalStatus
RoamingStatus
MobileCountryNetworkCode
common:ServiceError
4.2.2.6类型：ConnectionTypeForCollection当前终端连接类型集合见表8。
可选项
针对该终端地址的检索状态
终端漫游状态，当检索状态=Retrieved时应包含适用于服务网络的移动网络代码元组，当当前漫游状态是国内漫游或者国际漫游时应被包含当检索状态=Error时应包含，这是错误的原因元素
retrievalStatus
currentConnectionType
errorInformation
common:RetrievalStatus
当前终端连接类型集合
可选项
ConnectionType[o.unbounded]
common:ServiceError
类型：TerminalAccessibilityStatusList终端访问状态见表9。
表9终端访问状态
accessibility
resourceURL
TerminalAccessibilityStatus[I..unbounded]xsdsanyURI
针对该终端地址的检索状态
YD/T2940-2015
终端的集合类型，当检索状态-Retrieved时应包含当检索状态=Error时应包含，这是错误的原因可选项
终端访问状态集合
自指URL
允许在请求实体中出现名为terminalAccessibilityStatusList且类型为TerminalAccessibilityStatusList的根元素。
4.2.2.8类型：TerminalAccessibilityStatus当前终端访问状态见表10。
address
retrievalStatus
currentAccessibility
homeMccMnc
errorlnformation
Xsd:anyURI
common:RetrievalStatus
AccessibilityStatus
当前终端访问状态
可选项
MobileCountryNetworkCode
common:ServiceError
类型：TerminalRoamingStatusList终端漫游状态见表11。
表11终端漫游状态
roaming
resourceURL
TerminalRoamingStatus[l..unbounded]xsd:anyURI
访问状态信息适用的终端设备地址（如：sip'URI\tel' URI, acrURI)
该终端设备地址的检索状态
终端的访问状态，检索状态=Retrieved时应包含适用于家庭网络的移动网络代码元组当检索状态=Error时应包含，这是错误的原因可选项
终端漫游性状态集合
自指URL
允许在请求实体中出现名为roamingChangeNotification且类型为RoamingChangeNotification的根元素。4.2.2.10类型：TerminalRoamingStatus当前终端漫游性状态见表12。
2当前终端漫游性状态
address
retrievalStatus
currentRoaming
servingMccMnc
errorlnformation
xsd:anyURI
common:RetrievalStatus
RoamingStatus
MobileCountryNetworkCode
common:ServiceError
可选项
漫游性性状态信息适用的终端设备地址（如：sipURI, tel'URI, 'acr'URI)
该终端设备地址的检索状态
终端的漫游性状态，检索状态=Retrieved时应包含适用于服务网络的移动网络代码元组，当当前漫游状态是国内漫游或者国际漫游时应被包含当检索状态=Error时应包含，这是错误的原因7
YD/T2940-2015
类型：TerminalConnectionTypeList4.2.2.11
终端连接类型见表13。
表13终端连接类型
connectionType
resourceURL
TerminalConnectionType[1..unbounded]xsd:anyURI
可选项
终端连接状态集合
自指URL
允许在请求实体中出现名为terminalConnectionTypeList且类型为TerminalConnectionTypeList的根元素4.2.2.12类型：TerminalConnectionType当前连接类型见表14。
表14当前连接类型
address
retrievalStatus
currentConnectionType
errorInformation
xsd:anyURI
common:RetrievalStatus
ConnectionType [o..unbounded]common:ServiceError
类型：NotificationSubscriptionList可选项
状态集合访问、漫游性和连接变更通知订阅见表15。说明
连接类型信息适用的终端设备地址（如：sip\URI，'tel'URI, 'acrURI)
该终端设备地址的检索状态
终端连接类型，当检索状态=Retrieved时应包含当检索状态-Error时应包含，这是错误的原因表15状态集合访问、漫游性和连接变更通知订阅元素
collectionChangeSubscription类型
StatusCollectionChangeSubscription[o..unbounded]
accessibilityChangeSubscriptionAccessibilityChangeSubscription[o..unbounded]
roamingChangeSubscription
connectionChangeSubscriptionRoamingChangeSubscription
[o..unbounded]
ConnectionChangeSubscription[o..unbounded]
可选项
StatusCollectionChangeSubscription元素集合
AccessibilityChangeSubscription元素集合RoamingChangeSubscription元素集合ConnectionChangeSubseription元素集合允许在请求实体中出现名为notificationSubscriptionList且类型为NotificationSubscriptionList的根元素。4.2.2.14类型：StatusCollectionChangeSubscription终端状态集合变更通知订阅见表16。终端状态集合变更通知订阅
clientCorrelator
xsd:string
可选项
在一个用于在服务器上创建资源的请求中，可被客户端用于标定特定资源的相关因子。
该字段可能存在。
注意：此字段能使服务器在资源创建期间从通信故障中恢复，因此在这种情况下应避免重传在该字段存在的情况下，服务器不得改变它的取值，并且应该将其视为资源表示的一部分。如果字段缺省，服务器不得生成它
小提示：此标准内容仅展示完整标准里的部分截取内容，若需要完整标准请到上方自行免费下载完整标准文档。
中华人民共和国通信行业标准
YD/T2940-2015
基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端状态REsTfulbasedservicecapabilityopenAPl--Terminal status(OMA-TS-RESTNetAPITerminalStatus-V10-20121127-DRESTfulNetworkAPIforTerminalStatus，NEQ2015-07-14发布
2015-10-01实施
中华人民共和国工业和信息化部发布前
范围·
2规范性引用文件
3术语、定义和缩略语·
3.1术语和定义
3.2缩略语·
4终端状态API定义
功能的概述
资源概述
数据类型
流程图·
5资源详细规范
资源：终端状态集合·
资源：终端可访问性状态
资源：终端漫游状态
资源：终端连接类型
资源：状态集合变更通知订阅·资源：个人状态集合变更通知订阅资源：可访问性状态变更通知订阅·目
资源：个人可访问性状态变更通知订阅·资源：漫游状态变更通知订阅
资源：个人漫游状态变更通知订阅5.11
资源：连接类型变更通知订阅·5.12资源：个人连接类型变更通知订阅5.13资源：客户端的终端状态变更通知6错误定义·
服务异常·
6.2策略异常·
附录A（规范性附录）应用程序/x-www-form-urlencodedPOST操作请求格式·附录B（规范性附录）授权相关
YD/T2940-2015
··62
YD/T2940-2015
本标准是“基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）”系列标准之一，该系列标准的结构及名称预计如下：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）短消息和多媒体消息业务部分；
一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）点击拨号；一一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端状态；一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端能力信息：一一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）微博业务一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）搜索业务：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）地址本：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）文件传输业务：：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）定位业务：一一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）状态呈现业务：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）聊天业务一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）用户信息业务：一一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）支付业务；一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（APD）视频共享：基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）图片共享：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）移动互联网用户上下文感知业务。
本标准按照GB/T1.1-2009给出的规则起草。本标准使用重新起草法参考OMA-TS-RESTNetAPI_TerminalStatus-V10-20121127-D《基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端状态》编制，与OMA-TSREST_NetAPI_TerminalStatus-V1_0-20121127-D的一致性程度为非等效，主要做了如下编辑性修改：一删除了第4章“介绍”：
一删除了附录A（资料性附录）“变更历史”；一删除了附录B（规范性附录）“应用程序/x-www-form-urlencodedPOST操作请求格式”；一删除了附录D（资料性附录）“JSON实例”；删除了附录E（资料性附录）“ParlayX操作映射”；删除了附录F（资料性附录）“轻量级资源”。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。II
本标准由中国通信标准化协会提出并归口。本标准起草单位：北京邮电大学、中国信息通信研究院。YD/T2940-2015
本标准主要起草人：张勇、滕颖蕾、宋梅、鲍叙言、程刚、崔媛媛、陈国利、陈娟、韩滢、陈桦、宋朝阳、杨明、成晨、封龙、张雅君、杨露、卫海波、方一鸣、李沸乐、王东安。
1范围
基于表述性状态转移（REST）技术的业务能力开放应用程序接口（APD）终端状态YD/T2940-2015
本标准规定了基于表述性状态转移（REST）技术的终端状态的API接口定义、资源详细规范，以及错误定义。
本标准适用于提供终端状态能力开放的应用程序接口（API）。2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。IETFRFC2616
OMAOMA-RD-Autho4API10
OMAOMA-TS-REST_NetAPI
Common
OMAOMA-TS-REST_SUP
TerminalStatus
OMAOMA-TS-RESTNetAPI
NotificationChannel
W3CURLENC
W3CXMLSchemal
W3C XMLSchema2
ITU-TE.212
3术语、定义和缩略语
3.1术语和定义
下列术语和定义适用于本文件。3.1.1
超文本传输协议(HypertextTransferProtocol-HTTP)网络API授权架构(AuthorizationFrameworkforNetworkAPIs）基于表述性状态转移（REST）技术的网络应用程序接口（API）通用定义（CommondefinitionsforRESTfulNetworkAPIs）基于表述性状态转移（REST）技术的终端状态XML结构网络应用程序接（API）XMLstructureforRESTfulNetworkAPITerminalStatus)
基于表述性状态转移（REST）技术的通知通道网络应用程序接口(API)(NotificationChannelforRESTfulNetworkAPIs)超文本标记语言4.01规范，17.13.4节：表单内容类型（HTML4.01Specification, Section 17.13.4Form content types)可扩展标识语言架构第1部分：结构（第二版）(XMLSchemaPart1: Structures Second Edition)可扩展标识语言架构第2部分：数据类型（第二版）（XMLSchemaPart 2: Datatypes Second Edition)公开网络和订阅的国际识别计划（Theinternationalidentificationplan for public networks and subscriptions)客户端用于通知的URLClient-SideNotificationURL一个由客户端公开的HTTPURL，它可以接收通知，可以用于客户端订阅通知。3.1.2
通知信道NotificationChannel
一个在客户端请求的基础上创建的通道，用于从服务器向客户端发送通知。通道表示为一个资源，并通过指定的交付机制，为服务器发布和客户端接收通知提供方式。一
YD/T2940-2015
通知服务器NotificationServer一个可以创建和维护通知信道（NotificationChannels）的服务器。3.1.4
服务器端用于通知的URLServer-SideNotificationURL一个由通知服务器（NotificationServer）公开的HTTPURL。它标识一个客户端可以用于订阅通知的通知信道（NotificationChannel）。3.2缩略语
下列缩略语适用于本文件。
TD-SCDMA
Anonymous Customer ReferenceApplication Programming InterfaceCode Division Multiple AccessEnhancedDataratesforGSMEvolutionGeneral Packet Radio ServiceHyperText Transfer Protocol
High-SpeedDownlinkPacketAccessEvolved High-Speed Packet AccessHigh-Speed Uplink Packet AccessJavaScript Object Notation
Long Term Evolution
MobileCountry orGeographical Area CodesMultipurpose Internet Mail ExtensionsMobile Network Code
MobileNetworkOperator
MobileVirtual Network OperatorOpen MobileAlliance
REpresentational State TransferStatic Conformance RequirementsSession Initiation Protocol
Time Division Synchronous Code Division MultipleAccess
Technical Specification
Uniform Resource Identifier
Uniform Resource Locator
Wideband CodeDivisionMultipleAccessWorldwide Interoperability for Microwave AccessWireless Local Area Network
Extensible Markup Language
XMLSchema Definition
医名用户参考表
应用程序编程接口
码分多址接入
GSM演化的增强型数据速率
通用无线分组业务
超文本传输协议
高速下行分组接入
增强型高速分组接入
高速上行分组接入
JavaScript对象表示法
长期演进
移动城市或地区代码
多用途因特网邮件扩充
移动网络码
移动运营商
移动虚拟网络运营商
开放的移动联盟
表述性状态转移
静态符合性要求
会话初始化协议
时分一同步码分多址接入
技术规范
统一资源标识符
统一资源定位符
宽带码分多址接入
全球微波互联接入
无线局域网
可延伸标记语言
XML模式定义
4终端状态API定义
4.1功能的概无述
YD/T2940-2015
本章介绍了终端状态API的设计，详细介绍了所有资源定义、所有数据结构的定义、所有指定资源的详细操作定义。
第5章的所有例子的信息主体均是XML格式，见附录A。附录B规定了在结合某些授权框架的情况下，如何使用REST风格的终端状态API。4.2资源概述
本节中总结了关于终端状态的RESTful网络API中所用到的所有资源。\apiVersion\URL变量应有\vl\值，表明API对应于这个版本的标准，该变量的语义指定见OMA-TS-REST NetAPI Common。
图1可视化地展示了本标准中定义的资源结构。源树中那些与本标准中定义的HTTP方法关联的节点用固体盒子（实体源）描述。
/serverRoot/terminalstatus/apiVersion)fqueries
/statusCollection
accessibiityStatusO
/roamingStatus
/connectionType
/subscriptions
IstatusCollection
laccessibilityStatus
JroamingStatus C
IconnectionType
图1本标准定义的资源结构
Ksubscriptionld)
(subscriptionld)
(subscriptionldyO
(subscriptionld)
表1对本标准定义的资源结构做出了具体的描述，表现在数据类型和允许的HTTP方法表1目的：允许客户端检索终端状态集合，终端可访问性状态，漫游状态以及连接类型URL
终端状态集合
BaseURL:
http://(serverRoot)/termi
nalstatus/(apiVersion)
/queries/statusCollection
终端可访间性/queries/accessibilityStatus状态
终端漫游状态
/queries/roamingStatus
数据结构
TerminalStatusCollectionListTerminalAccessibilityStatusListTerminalRoamingStatusList
HTTP方法
返回当前可访问性状态，
漫游状态，以及一种或多
种终端连接类型
返回当前一种或多种终
端可访间性状态
返回当前一种或多种终
端漫游状态
DELETE
YD/T2940-2015
Base URL:
http://(serverRoot)/termi
nalstatus/(apiVersion)
终端连接类型
表1（续）
数据结构
/queries /connectionTypeTerminalConnectionTypeList表2表示了允许客户端管理终端状态变更通知的订阅。GET
HTTP方法
POSTDELETE
返回当前一种或多种终
端连接类型
表2目的：允许客户端管理终端状态变更通知的订阅URL
BaseURL:
http://(serverRoot)/termin
alstatus/(apiVersion)
状态集合变更通/subscriptions/status知的订阅
Collection
数据结构
NotificationSubscriptionL
ist（此数据结构适用于
“GET”动作】
StatusCollectionChanges
ubscription（适用于
“POST”动作
common:ResourceReferen
ce（适用于POST应答的
可选项）
个人状态集合变/subscriptions/statusColleStatusCollectionChangesubscription（适用于
更通知的订阅
ction/(subscriptionId)
个人状态变更通/subscriptions/accessibility知的订阅
Status
个人可访间性状/subscriptions/accessibility态变更通知的
Status//subscriptionld?
漫游状态变更通/subscriptions/roaming知的订阅
Status
个人漫游状态变/subscriptions/roaming更通知的订阅
Status/(subscriptionId
“GET”和“PUT”动作】
NotificationSubscriptionL
ist（适用于“GET”动作）
AccessibilityChangeSubsc
ription（适用于“POST”
动作）
common:ResourceReferen
ce（适用于POST应答的
可选项）
返回所有订阅
HTTP方法
返回某个订阅 更新订阅
返回所有订阅
AccessibilityChangeSubsc返回某个订阅更新订阅ription（适用于“GET\
和“PUT”动作】
NotificationSubscriptionL
ist（适用于“GET”动作）
RoamingChangeSubscript
ion（适用于“POST\
动作）
common:ResourceReferen
ce（适用于POST应答的
可选项）
返回所有订阅
t返回某个订阅更新订阅
RoamingChangeSubscript
ion（适用于\GET”和
“PUT”动作）
创建新的
创建新的
创建新的
DELETE
删除某个订阅
删除某个订阅
删除某个订阅
BaseURL:
http://serverRoot//termin
alstatus/(apiVersion)
表2（续）
数据结构
连接类型变更通/subscriptions/connectionNotificationSubscriptionL
返回所有订阅
知的订阅
ist（适用于“GET”动作）
ConnectionChangeSubscri
ption（适用于“POST\
动作）
common:ResourceReferen
ce（适用于POST应答的
可选项）
HTTP方法
个人连接类型变/subscriptions/conncctionConnectionChangeSubscri返回某个订阅更新订阅
更通知的订阅
Type/(subscriptionId)
ption（适用于“GET”和
“PUT”动作）
允许服务器通知客户端关于终端状态的变更见表3。表3目的：允许服务器通知客户端关于终端状态的变更URL
关于终端状态
变更的客户端
BaseURL:
http://(serverRoot)/term
inalstatus/(apiVersion)
(provided by client)
4.3数据类型
4.3.1XML命名空间
数据结构
StatusCollectionChangeNotificationAccessibilityChangeNotificationRoamingChangeNotification
ConnectionChangeNotificationSubscriptionCancellationNotification对TerminalStatus数据类型XML命名空间是：urn:oma:xml:rest:netapi:terminalstatus:1GET
YD/T2940-2015
创建新的
HTTP方法
DELETE
删除某个订阅
DELETE
关于终端状态
变更的通知
“xsd'命名前缀在当前文档中的使用是为了参考在XML架构（见XMLSchemal，见XMLSchema2.）中定义的XML架构数据类型。“common'的命名前缀在当前文档中的使用是为按照在OMA-TS-RESTNetAPICommon中定义的数据类型。命名前缀的使用，例如：“xsd\，并没有语义上的重要性。
在接下来的部分中定义的针对数据结构的XML架构应按照OMA-TS-RESTSUP_TerminalStatus给出。
跟随针对终端状态V1.0版本的RESTful网络的API应使用命名空间urn:oma:xml:rest:netapi:terminalstatus:14.3.2结构
4.2.2.1对后续章节的相关的数据结构说明在4.2.2.2~4.2.2.23中对在终端状态API中使用的数据结构进行了定义，某些结构能够实例化为所谓5
YD/T2940-2015
的根元素。第5章中关于“tel\sip'和\acr\统一标识符方案的陈述，对那些包含了说明用户标识符元素的结构做了申请。
4.2.2.2类型：TerminalStatusCollectionList终端状态集合见表4。
表4终端状态集合
collection
resourceURL
TerminalStatusCollection[1..unbounded]xsd:anyURI免费标准bzxz.net
可选项
收集终端状态集合
自指URL
允许在请求实体中出现名为terminalStatusCollectionList且类型为TerminalStatusCollectionList的根元素。
4.2.2.3类型：TerminalStatusCollection当前终端状态集合见表5。
表5当前终端状态集合
address
accessibility
roaming
connectionType
xsd:anyURI
AccessibilityStatusForCollectionRoamingStatusForCollection
ConnectionTypeForCollection
4.2.2.4类型：AccessibilityStatusForCollection当前终端连接访问状态集合见表6。表6
retrievalStatus
currentAccessibility
homeMccMne
errorInformation
可选项
当前终端连接访问状态集合
可选项
common:RetrievalStatus
RoamingStatus
MobileCountryNetworkCode
common:ServiceError
4.2.2.5类型：RoamingStatusForCollection当前终端漫游状态集合见表7。
状态集合信息适用的终端设备地址(如：sipURIL,'te'URI,acr'URI)终端访问状态
终端漫游状态
终端的连接状态
针对该终端地址的检索状态
终端的访间状态，检索状态=Retrieved时应包含适用于家庭网络的移动网络代码元组当检索状态=Error时应包含，这是错误的原因当前终端漫游状态集合
retrievalStatus
currentRoaming
servingMecMnc
errorlnformation
common:RetrievalStatus
RoamingStatus
MobileCountryNetworkCode
common:ServiceError
4.2.2.6类型：ConnectionTypeForCollection当前终端连接类型集合见表8。
可选项
针对该终端地址的检索状态
终端漫游状态，当检索状态=Retrieved时应包含适用于服务网络的移动网络代码元组，当当前漫游状态是国内漫游或者国际漫游时应被包含当检索状态=Error时应包含，这是错误的原因元素
retrievalStatus
currentConnectionType
errorInformation
common:RetrievalStatus
当前终端连接类型集合
可选项
ConnectionType[o.unbounded]
common:ServiceError
类型：TerminalAccessibilityStatusList终端访问状态见表9。
表9终端访问状态
accessibility
resourceURL
TerminalAccessibilityStatus[I..unbounded]xsdsanyURI
针对该终端地址的检索状态
YD/T2940-2015
终端的集合类型，当检索状态-Retrieved时应包含当检索状态=Error时应包含，这是错误的原因可选项
终端访问状态集合
自指URL
允许在请求实体中出现名为terminalAccessibilityStatusList且类型为TerminalAccessibilityStatusList的根元素。
4.2.2.8类型：TerminalAccessibilityStatus当前终端访问状态见表10。
address
retrievalStatus
currentAccessibility
homeMccMnc
errorlnformation
Xsd:anyURI
common:RetrievalStatus
AccessibilityStatus
当前终端访问状态
可选项
MobileCountryNetworkCode
common:ServiceError
类型：TerminalRoamingStatusList终端漫游状态见表11。
表11终端漫游状态
roaming
resourceURL
TerminalRoamingStatus[l..unbounded]xsd:anyURI
访问状态信息适用的终端设备地址（如：sip'URI\tel' URI, acrURI)
该终端设备地址的检索状态
终端的访问状态，检索状态=Retrieved时应包含适用于家庭网络的移动网络代码元组当检索状态=Error时应包含，这是错误的原因可选项
终端漫游性状态集合
自指URL
允许在请求实体中出现名为roamingChangeNotification且类型为RoamingChangeNotification的根元素。4.2.2.10类型：TerminalRoamingStatus当前终端漫游性状态见表12。
2当前终端漫游性状态
address
retrievalStatus
currentRoaming
servingMccMnc
errorlnformation
xsd:anyURI
common:RetrievalStatus
RoamingStatus
MobileCountryNetworkCode
common:ServiceError
可选项
漫游性性状态信息适用的终端设备地址（如：sipURI, tel'URI, 'acr'URI)
该终端设备地址的检索状态
终端的漫游性状态，检索状态=Retrieved时应包含适用于服务网络的移动网络代码元组，当当前漫游状态是国内漫游或者国际漫游时应被包含当检索状态=Error时应包含，这是错误的原因7
YD/T2940-2015
类型：TerminalConnectionTypeList4.2.2.11
终端连接类型见表13。
表13终端连接类型
connectionType
resourceURL
TerminalConnectionType[1..unbounded]xsd:anyURI
可选项
终端连接状态集合
自指URL
允许在请求实体中出现名为terminalConnectionTypeList且类型为TerminalConnectionTypeList的根元素4.2.2.12类型：TerminalConnectionType当前连接类型见表14。
表14当前连接类型
address
retrievalStatus
currentConnectionType
errorInformation
xsd:anyURI
common:RetrievalStatus
ConnectionType [o..unbounded]common:ServiceError
类型：NotificationSubscriptionList可选项
状态集合访问、漫游性和连接变更通知订阅见表15。说明
连接类型信息适用的终端设备地址（如：sip\URI，'tel'URI, 'acrURI)
该终端设备地址的检索状态
终端连接类型，当检索状态=Retrieved时应包含当检索状态-Error时应包含，这是错误的原因表15状态集合访问、漫游性和连接变更通知订阅元素
collectionChangeSubscription类型
StatusCollectionChangeSubscription[o..unbounded]
accessibilityChangeSubscriptionAccessibilityChangeSubscription[o..unbounded]
roamingChangeSubscription
connectionChangeSubscriptionRoamingChangeSubscription
[o..unbounded]
ConnectionChangeSubscription[o..unbounded]
可选项
StatusCollectionChangeSubscription元素集合
AccessibilityChangeSubscription元素集合RoamingChangeSubscription元素集合ConnectionChangeSubseription元素集合允许在请求实体中出现名为notificationSubscriptionList且类型为NotificationSubscriptionList的根元素。4.2.2.14类型：StatusCollectionChangeSubscription终端状态集合变更通知订阅见表16。终端状态集合变更通知订阅
clientCorrelator
xsd:string
可选项
在一个用于在服务器上创建资源的请求中，可被客户端用于标定特定资源的相关因子。
该字段可能存在。
注意：此字段能使服务器在资源创建期间从通信故障中恢复，因此在这种情况下应避免重传在该字段存在的情况下，服务器不得改变它的取值，并且应该将其视为资源表示的一部分。如果字段缺省，服务器不得生成它
小提示：此标准内容仅展示完整标准里的部分截取内容，若需要完整标准请到上方自行免费下载完整标准文档。