YD/T 2940-2015 基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API） 终端状态

ICS33.040

M21YD

中华人民共和国通信行业标准

YD/T2940—2015

基于表述性状态转移（REST)技术的业务

能力开放应用程序接口（API)终端状态

RESTfulbasedservicecapabilityopenAPI-Terminalstatus

(OMA-TS-REST—NetAPI—TerminalStatus-V1—0-20121127-D，

RESTfulNetworkAPIforTerminalStatus，NEQ)

2015—07-14发布2015-10-01实施

中华人民共和国工业和信息化部发布

YD/T2940-2015

目次

m言...............................................................................................................................................................................ii

iISH...................................................................................................................i

2规范性引用文件......................................................................................................................................一1

3术语、定义和缩略语................................................................................................................................................1

3.1术语和定义.....................................................................................................................................1

3.2吾...............................................................................................................................................................2

4终端状态API定义..................................................................................................................................................3

4.1功能的概述.......................................................................................................................................................3

4.2资源概述..............................................................................3

4.3数据类型.............................................................................................................5

4.4流程图....................................................................................................................................*....................16

5资源详细规范.........................................................................................................................................................18

5.1资源：终端状态集合......................................................................................................................................18

5.2资源:终端可访问性状态..............................................................................................................................21

5.3资源:终端漫游状态.......................................................................................................................................24

5.4资源：终端连接类型....................................................................................................................................27

5.5资源：状态集合变更通知订阅.....................................................................................................................31

5.6资源:个人状态集合变更通知订阅........................................................................................................35

5.7资源：可访问性状态变更通知订阅..........................................................................................................38

5.8资源：个人可访问性状态变更通知订阅.................................................................................................42

5.9资源:漫游状态变更通知订阅...................................................................45

5.10资源：个人漫游状态变更通知订阅.............................................................48

5.11资源：连接类型变更通知订阅...........................................-51

5.12资源:个人连接类型变更通知订阅............................................................................................54

5.13资源：客户端的终端状态变更通知..............................57

6縣紋...............................-61

6.1服务异常............................................................................................................................................61

6.2策略异常........................................................................................................................................................61

附录A(规范性附录）应用程序/x-www-form-urlencodedPOST操作请求格式.............................................62

附录B(规范性附录）授权相关.............................................................................................................................71

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)技术的业务能力开放应用程序接口（AH)视频共享；

——基于表述性状态转移（REST)技术的业务能力开放应用程序接口（API)图片共享；

一一基于表述性状态转移（REST)技术的业务能力开放应用程序接口（API)移动互联网用户上下

文感知业务。

本标准按照GB/T1.1-2009给出的规则起草。

本标准使用重新起草法参考〇MA-TS-REST_NetAPI_TerminalStatos-Vl_0-20121127-D《基于表述性状

态转移（REST)技术的业务能力开放应用程序接口（API)终端状态》编制，与OMA-TS-

REST_NetAPI_TerminalStatus-Vl_0-20121127-D的一致性程度为非等效，主要做了如下编辑性修改：

——删除了第4章“介绍”；

—删除了附录A(资料性附录）“变更历史”；

------删除了附录B(规范性附录）“应用程序/x-www-form-urlencodedPOST操作请求格式”；

——删除了附录D(资料性附录）“JSON实例”；

——删除了附录E(资料性附录）“ParlayX操作映射”；

——删除了附录F(资料性附录）“轻量级资源”。

请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。

YD/T2940-2015

本标准由中国通信标准化协会提出并归口。

本标准起草单位：北京邮电大学、中国信息通信研究院。

本标准主要起草人：张勇、滕颖蕾、宋梅、鲍叙言、程刚、崔媛媛、陈国利、陈娟、韩

澄、陈桦、宋朝阳、杨明、成晨、封龙、张雅君、杨露、卫海波、方一鸣、李沸乐、王东

安。

III

YD/T2940-2015

基于表述性状态转移（REST)技术的

业务能力开放应用程序接口（API)终端状态

1范围

本标准规定了基于表述性状态转移（REST)技术的终端状态的API接口定义、资源详细规范，以及

错误定义。

本标准适用于提供终端状态能力开放的应用程序接口（API)。

2规范性引用文件

下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文

件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。

IETFRFC2616超文本传输协议(HypertextTransferProtocol--HTTP)

OMAOMA-RD-Autho4API_10网络API授权架构(AuthorizationFrameworkforNetworkAPIs)

OMAOMA-TS-REST—NetAPI一基于表述性状态转移（REST)技术的网络应用程序接口（API)

Common通用定义（CommondefinitionsforRESTfulNetworkAPIs)

OMAOMA-TS-REST—SUP一基于表述性状态转移（REST)技术的终端状态XML结构网络应用

TerminalStatus程序接口（API)(XMLstructureforRESTfulNetworkAPITermmal

Status)

OMAOMA-TS-REST_NetAPI_基于表述性状态转移（REST)技术的通知通道网络应用程序接口

NotificationChannel(API)(NotificationChannelforRESTfulNetworkAPIs)

W3CURLENC超文本标记语言4.01规范，17.13.4节：表单内容类型（HTML4.01

Specification,Section17.13.4Formcontenttypes)

W3CXMLSchemal可扩展标识语言架构第1部分：结构（第二版）（XMLSchemaPart

1:StructuresSecondEdition)

W3CXMLSchema2可扩展标识语言架构第2部分：数据类型(第二版）（XMLSchema

Part2:DatatypesSecondEdition)

ITU-TE.212公开网络和订阅的国际识别计划（Theinternationalidentification

planforpublicnetworksandsubscriptions)

3术语、定义和缩略语

3.1术语和定义

下列术语和定义适用于本文件。

3.1.1

客户端用于通知的URLClient-SideNotificationURL

一个由客户端公开的HTTPURL,它可以接收通知,可以用于客户端订阅通知。

3.1.2

通知信道NotificationChannel

一个在客户端请求的基础上创建的通道，用于从服务器向客户端发送通知。通道表示为一个资源，并

通过指定的交付机制，为服务器发布和客户端接收通知提供方式。

YD/T2940-2015

3.1.3

通知服务器Not丨ficationServer

一个可以创建和维护通知信道（NotificationChannels)的服务器。

3.1.4

服务器端用于通知的URLServer-SideNotificationURL

一个由通知服务器（NotificationServer)公开的HTTPURL。它标识一个客户端可以用于订阅通知的

通知信道（NotificationChannel)。

3.2缩略语

下列缩略语适用于本文件。

ACRAnonymousCustomerReference匿名用户参考表

APIApplicationProgrammingInterface应用程序编程接口

CDMACodeDivisionMultipleAccess码分多址接入

EDGEEnhancedDataratesforGSMEvolutionGSM演化的增强型数据速率

GPRSGeneralPacketRadioService通用无线分组业务

HTTPHyperTextTransferProtocol超文本传输协议

HSDPAHigh-SpeedDownlinkPacketAccess髙速下行分组接入

HSPA+EvolvedHigh-SpeedPacketAccess增强型高速分组接入

HSUPAHigh-SpeedUplinkPacketAccess高速上行分组接入

JSONJavaScriptObjectNotationJavaScript对象表示法

LTELongTermEvolution长期演进

MCCMobileCountryorGeographicalAreaCodes移动城市或地区代码

MIMEMultipurposeInternetMailExtensions多用途因特网邮件扩充

MNCMobileNetworkCode移动网络码

MNOMobileNetworkOperator移动运营商

MVNOMobileVirtualNetworkOperator移动虚拟网络运营商

OMAOpenMobileAlliance开放的移动联盟

RESTREpresentationalStateTransfer表述性状态转移

SCRStaticConformanceRequirements静态符合性要求

SIPSessionInitiationProtocol会话初始化协议

TD-SCDMATimeDivisionSynchronousCodeDivisionMultiple时分一同步码分多址接入

Access

TSTechnicalSpecification技术规范

URIUniformResourceIdentifier统一资源标识符

URLUniformResourceLocator统一资源定位符

WCDMAWidebandCodeDivisionMultipleAccess宽带码分多址接入

WiMAXWorldwideInteroperabilityforMicrowaveAccess全球微波互联接入

WLANWirelessLocalAreaNetwork无线局域网

XMLExtensibleMarkupLanguage可延伸标记语言

XSDXMLSchemaDefinitionXML模式定义

YD/T2940-2015

4终端状态API定义

4.1功能的概述

本章介绍了终端状态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}

---------./queries

/statusCol丨ection〇|]

—[/accessibilityStatus~^^

——r,r〇amingStatusCj

L—[/connectionType〇；]

1----------/subscriptions

——[/statusCollection〇|)

/{subscriptionld}

(/accessibilityStatus!j|

/{subscriptionid}J

—(/roamingStatusCM

/{subscriptionld}Q)

~~[/connectionTypeOil

i___/{subscriptionld}

图1本标准定义的资源结构

表1对本标准定义的资源结构做出了具体的描述，表现在数据类型和允许的HTTP方法。

表1目的：允许客户端检索终端状态集合，终端可访问性状态，漫游状态以及连接类型

URLHTTP方法

BaseURL:

资源数据结构

http://{serverRoot}/termiGETPUTPOSTDELETE

nalstatus/{apiVersion}

终端状态集合/queries/statusCollectionTerminalStatusCollectionList返回当前可访问性状态，否否否

漫游状态，以及一种或多

种终端连接类型

终端可访问性/queries/accessibilityStatusTerminaLAccessibilityStatusList返回当前一种或多种终否否否

状态端可访问性状态

终端漫游状态/queries/roamingStatusTerminalRoamingStatusList返回当前一种或多种终否否否

端漫游状态

YD/T2940-2015

表1(续)

URLHTTP方法

BaseURL:

资源数据结构

http://{serverRoot}/termiGETPUTPOSTDELETE

nalstatus/{apiVersion}

终端连接类型/queries/connectionTypeTerminalConnectionTypeList返回当前一种或多种终否否否

端连接类型

表2表示了允许客户端管理终端状态变更通知的订阅。

表2目的：允许客户端管理终端状态变更通知的订阅

URLHTTP方法

BaseURL:

资源数据结构

http://{serverRoot}/terminGETPUTPOSTDELETE

alstatus/{apiVersion}

状态集合变更通/subscriptions/statusNotificationSubscriptionL返回所有订阅否创建新的否

(此数据结构适用于

知的订阅Collectionist订阅

“GET”动作）

StatusCollectionChangeS

ubscription(适.用于

“POST”动作）

common:ResourceReferen

ce(适用于POST应答的

可选项）

个人状态集合变/subscriptions/statusColleStatusCollectionChangeS返回某个订阅更新订阅否删除某个订阅

(适用于

更通知的订阅ction/{subscriptionId}ubscription

“GET”和“PUT”动作)

个人状态变更通/subscriptions/accessibilityNotificationSubscriptionL返回所有订阅否创建新的否

ist(适用于“GET”动作)

知的订阅Status订阅

AccessibilityChangeSubsc

ription(适用于“POST”

动作）

common:ResourceReferen

ce(适用于POST应答的

可选项）

个人可访问性状/subscriptions/accessibilityAccessibilityChangeSubsc返回某个订阅更新订阅否删除某个订阅

态变更通知的Status/{subscriptionId}ription(适用于“GET”

订阅和“PUT”动作）

漫游状态变更通/subscriptions/roamingNotificationSubscriptionL返回所有订阅否创建新的否

知的订阅Statusist(适用于“GET”动作；)订阅

RoamingChangeSubscript

ion(适用于“POST”

动作）

common:ResourceReferen

ce(适用于POST应答的

可选项）

个人漫游状态变/subscriptions/roamingRoamingChangeSubscript返回某个订阅更新订阅否删除某个订阅

更通知的订阅Status/{subscription^}ion(适用于“GET”和

“PUT”动作）

YD/T2940-2015

表2(续)

URLHTTP方法

BaseURL:

资源数据结构

http://{serverRoot}/terminGETPUTPOSTDELETE

alstatus/{apiVersion}

连接类型变更通/subscriptions/connectionNotificationSubscriptionL返回所有订阅否创建新的否

知的订阅Typeist(适用于“GET”动作)订阅

ConnectionChangeSubscri

ption(适用于“POST”

动作）

common:ResourceReferen

ce(适用于POST应答的

可选项）

个人连接类型变/subscriptions/connectionConnectionChangeSubscri返回某个订阅更新订阅否删除某个订阅

更通知的订阅Type/{subscriptionld}ption(适用于“GET”和

“PUT”动作）

允许服务器通知客户端关于终端状态的变更见表3。

表3目的：允许服务器通知客户端关于终端状态的变更

URL