首页 > 通信行业标准(YD) > YD/T 3103-2016 基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)终端能力信息业务
YD/T 3103-2016

基本信息

标准号: YD/T 3103-2016

中文名称:基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)终端能力信息业务

标准类别:通信行业标准(YD)

标准状态:现行

出版语种:简体中文

下载格式:.zip .pdf

相关标签: 基于 表述 状态 转移 技术 业务 能力 开放 应用 程序接口 终端 信息

标准分类号

关联标准

出版信息

相关单位信息

标准简介

YD/T 3103-2016.RESTful based service capability open API-terminal capabilities.
1范围
YD/T 3103规定了基于表述性状态转移(REST)技术的终端能力信息业务开放应用程序接口(API) ,包括接口数据结构、接口定义、资源详细定义等。
YD/T 3103适用于提供终端能力信息业务开放的应用程序接口(API)。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅所注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
IETFACRdraft匿名用户参考统一资源标识符
IETF RFC3261 Session Initiation Protocal会话发起协议
IETF RFC 3986 Uniform Resource Identifier (UR): Generic Syntax统-资源标识符(URI):通用的语法OMA-ER-Autho4API-V1_ 0-20131120-C 网络API授权架构(Authorization Framework for Network APIs)
OMA-SUP-XSD_rest_ netapi_ devicecapabilities-V1_ 0-20130924-A 终 端能力RESTful 网络API的XSD (XML schema for the RESTful Network API for Device Capabilities )

标准图片预览






标准内容

ICS33.040
中华人民共和国通信行业标准
YD/T3103-2016
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)终端能力信息业务
REsTful based servicecapabilityopenAPl-terminal capabilities2016-07-11发布
2016-10-01实施
中华人民共和国工业和信息化部发布前
规范性引用文件
缩略语·
接口概述·
接口定义·
接口概述·
资源概述
数据类型
流程:
资源详细定义
资源定义说明·
资源:终端能力·
资源:终端能力改变通知的订阅·目
资源:由订阅标识符指定的终端能力改变通知的单一订阅资源:终端能力改变通知:
资源:终端配置..
资源:可用的终端配置·
资源:配置历史·
附录A(规范性附录)授权相关
参考文献
YD/T3103-2016
YD/T3103-2016
本标准是“基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)”系列标准之一,该系列标准的结构及名称预计如下:基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)短消息和多媒体消息业务:
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)点击拨号业务:
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)终端状态;免费标准下载网bzxz
基于表述性状态转移(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)移动互联网用户上下文感知业务:
YD/T3103-2016
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)非结构化补充数据业务。
随着技术和市场的发展,还将根据情况制定后续相关标准。本标准按照GB/T1.1-2009给出的规则起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。
本标准由中国通信标准化协会提出并归口。本标准起草单位:中国联合网络通信集团有限公司、北京邮电大学、中兴通讯股份有限公司、中国信息通信研究院、华为技术有限公司。本标准主要起草人:胡尼亚、张勇、董昊、刘东明、马卫东。1范围
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)终端能力信息业务
YD/T3103-2016
本标准规定了基于表述性状态转移(REST)技术的终端能力信息业务开放应用程序接口(API),包括接口数据结构、接口定义、资源详细定义等。本标准适用于提供终端能力信息业务开放的应用程序接口(API)。2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅所注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
IETFACRdraft匿名用户参考统一资源标识符IETFRFC3261SessionInitiationProtocal会话发起协议IETFRFC3986UniformResourceIdentifier(URD:GenericSyntax统一资源标识符(URI):通用的语法OMA-ER-Autho4API-V1_0-20131120-C网络API授权架构(AuthorizationFrameworkforNetworkAPIs)OMA-SUP-XSD_rest_netapidevicecapabilities-V1_0-20130924-A终端能力RESTful网络API的XSD(XMLschemafortheRESTfulNetworkAPIforDeviceCapabilities)OMA-TS-REST_Common-V1_0-20120724-ARESTful网络API通用定义(CommondefinitionsforRESTfulNetworkAPIs)
OMA-TS-RESTNetAPINotificationChannel-V10-20140319-D-20140319-D通知信道RESTful网络API(RESTfulNetworkAPI forNotificationChannel)W3CXMLSchemal可扩展标识语言架构第1部分:结构(第二版)(W3CRecommendation,XMLSchemaPart l:Structures Second Edition)W3CXMLSchema2可扩展标识语言架构第2部分:数据类型(第二版)(W3CRecommendation,XMLSchemaPart2:Datatypes SecondEdition)3缩略语
下列缩略语适用于本文件。
Anonymous Customer ReferenceApplicationProgrammingInterfaceHyperTextTransferProtocol
Identifier
International Mobile Equipment Identification NumberJavaScript Object Notation
MobileEquipmentIdentifier
匿名用户参考
应用程序编程接口
超文本传送协议
标识符
国际移动终端识别码
JavaScript对象表示法
CDMA移动设备识别码唯一的识
YD/T3103-2016
4接口概述
Representational State TransferTelecom service Open PlatformUniform Resource Identifier
UniformResourceLocator
eXtensibleMarkup Language
XML Schema Definition
表述性状态转移
电信业务能力开放平台
统一资源标识符
统一资源定位符
可扩展标记语言
XML架构定义
终端能力信息API可以提供查询用户终端能力、设置终端配置、获取终端手机号等功能。可以为应用自动识别终端的能力,从而可以优化传递给终端的内容格式,更好地适配用户终端。终端能力信息存储在电信运营商的终端管理平台中。5接口定义
5.1接口概述
本章给出对终端能力信息API设计的全面理解。它明确给出了所有资源和所有数据结构的定义,同时定义了关于这些数据的所允许的所有操作。通用数据类型、命名规则、错误定义以及命名空间在OMA-TS-REST_Common-V1_0-20120724-A中被定义。5.2资源概述
表1给出了“终端能力”资源的详细说明、数据结构以及允许的HTTP方法。表1应用查询终端能力
URL:基础URL
终端能力
http://(serverRoot)/devicecapabilities/(apiVersion)
/(equipmentld)/capabilities
数据结构
DeviceCapabilities
查询终端能力
HTTP方法
DELETE
表2给出了规范中定义的“终端能力改变通知的订阅”和“由订阅标识符指定的终端功能改变通知的单个订阅”资源的详细说明、数据结构以及允许的HTTP方法。表2应用管理终端能力改变订阅
URL:基础URL:
http://(serverRoot)/
devicecapabilities/
(apiVersion)
终端能力改变/(equipmentld)/subscri通知的订阅
ptions
数据结构
DeviceCapabilities
查询终端能力改变
ChangeSubscriptionList通知订阅的列表DeviceCapabilities
ChangeSubscription
(用在POST消息中)
由订阅标识符/(equipmentld)/subscripDeviceCapabilities
指定的终端功tions/(subscriptionId)能改变通知的
ChangeSubscription
查询一个由订阅
标识符指定的终
端能力改变通知
HTTP方法
创建一个终
端能力改变
通知的订阅
DELETE
删除一个由订阅
标识符指定的终
端能力改变通知
单个订阅
URL:基础URL:
http://(serverRoot)/
devicccapabilities/
(apiVersion)
数据结构
订阅信息
HTTP方法
YD/T3103-2016
DELETE
订阅信息
表3给出了规范中定义的“终端能力改变通知的订阅”和“由订阅标识符指定的终端功能改变通知的单个订阅”资源的详细说明、数据结构以及允许的HTTP方法。表3
URL基础URL:
http://serverRoot/deviceca
pabilities/(apiVersion)
终端能力改应用定义
变通知
应用接收终端能力改变通知
HTTP方法
数据结构
DeviceCapabilitiesNotificationDeviceCapabilitiesCancellationNotification
向应用程序发
送通知
DELETB
表4给出了规范中定义的“应用配置终端”和“查询终端可用配置”、“查询终端历史配置信息”资源的详细说明、数据结构以及允许的HTTP方法。表4应用配置终端、查询终端可用配置、查询终端历史配置信息资源
终端配置
可用的配置
配置历史
URL:基础URL:
ttp://(serverRoot)/devicecapabilities/(apiVersion)
/equipmentid/configuration
/fequipmentidy/configuration/available
/equipmentIdy/configuration/history
数据结构
DeviceConfigurat
DeviceConfigurat
ionList
DeviceConfigurat
ionHistoryList
查询可用的终
端配置
查询某终端的
配置历史记录
HTTP方法
表1至表4中\apiVersion\需要用V1值指明是本规范所定义的版本。5.3数据类型
5.3.1XML命名空间
终端功能数据类型的命名空间是:urn:oma:xml:rest:netapi:devicecapabilities:1POST
+个或一组终端
添加一个配置
DELETE
当前文档中使用的命名空间'xsd'见W3CXMLSchemal和W3CXMLSchema2中定义的XML模式数据类型。当前文档中使用的命名空间common'是指OMA-TS-RESTCommon-V1_0-20120724-A中定义的数据类型。名字“xsd”和“common”的使用在语义上不是非常显著的。在接下来的部分中定义的数据类型的XML模式,在OMA-SUP-XSD_restnetapi_devicecapabilities-V10-20130924-A中被给定。
5.3.2数据类型
5.3.2.1类型:DeviceCapabilities终端能力查询功能的数据类型见表5。表5
终端能力查询元素
可选/必选
YD/T3103-2016
deviceld
resourceURL
xsd:string
xsd:string
xsd:anyURI
common:Link[o..unbounded]
唯一的终端标识符(例如:IMEI/MEID)终端名称
本资源地址
服务端提供的,指向与当前资源有关联的其他资源(例如,UserAgentProfileReference)类型为DeviceCapabilities名字为deviceCapabilities的根元素,允许出现在响应消息中。5.3.2.2类型:DeviceCapabilitiesNotification功能变更通知的终端功能的数据类型见表6。表6
callbackData
changeNotificationEnd
deviceAddress
deviceld
xsd:string
xsd:boolcan
xsd:anyURI
xsd:string
common:Link
[o..unbounded]
终端能力通知元素
可选/必选
在订阅操作相关的创建期间在callbackReference元素中通过应用程序传递的CallbackData。详见OMA-TS-REST_Common-VI0-20120724-A
默认值:false
设置为true,如果它是关于状态变化的最后一个通知如果该通知涉及一个单独的终端指终端的地址(例如,“sip”URI,“tel\URI,acr\URI)。如果其通知适用于整个订阅它不表达唯一的终端标识符(e.g.IMEI/MEID)由服务器提供的,指向与当前资源有关的其他资源(例如,DeviceCapabiliticsChangeSubscription,DeviceConfiguration)名字为deviceCapabilitiesNotification类型为DeviceCapabilitiesNotification的根元素,允许出现在请求和/或响应报文中。
5.3.2.3类型:DeviceCapabilitiesCancellationNotification终端功能通知的取消功能的数据类型见表7。表7终端通知取消功能元素
callbackData
deviceAddress
Reason
xsd:string
xsd:anyURI
common:ServiceError
common:Link
[O..unbounded]
可选/必选
在订阅操作相关的创建期间在callbackReference元素中通过应用程序传递的CallbackData。详见OMA-TS-REST_Common-V1 0-20120724-A
如果该通知涉及一个单独的终端指终端的地址(例如,‘sip\URL,teP'URI,“acr\URI)。如果其通知适用于整个订阅它不表达通知被终止的原因
由服务器提供的,指向与当前资源有关的其他资源(例如,DeviceCapabilitiesChangeSubscription,DeviceConfiguration)名字为deviceCapabilitiesCancellationNotification类型为DeviceCapabilitiesCancellationNotification的根元素,允许出现在请求和/或响应报文主体中。5.3.2.4类型:ConfigurationHistoryEntry终端配置历史记录查询的数据类型见表8。表8
deviceConfigurationDeviceConfiguration4
终端配置历史记录元素
可选/必选
终端配置
小提示:此标准内容仅展示完整标准里的部分截取内容,若需要完整标准请到上方自行免费下载完整标准文档。