DOC

OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D

By Betty Price,2014-09-12 23:03
10 views 0
OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D

    RESTful Network API for

    Device Capabilities

    Draft Version 1.0 02 Oct 2012

    Open Mobile Alliance OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D

2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D Page 2 (68)

    Use of this document is subject to all of the terms and conditions of the Use Agreement located at http://www.openmobilealliance.org/UseAgreement.html.

    Unless this document is clearly designated as an approved specification, this document is a work in process, is not an approved Open Mobile Alliance? specification, and is subject to revision or removal without notice.

    You may use this document or any part of the document for internal or educational purposes only, provided you do not modify, edit or take out of context the information in this document in any manner. Information contained in this document may be used, at your sole risk, for any purposes. You may not use this document in any other manner without the prior written permission of the Open Mobile Alliance. The Open Mobile Alliance authorizes you to copy this document, provided that you retain all copyright and other proprietary notices contained in the original materials on any copies of the materials and that you comply strictly with these terms. This copyright permission does not constitute an endorsement of the products or services. The Open Mobile Alliance assumes no responsibility for errors or omissions in this document. Each Open Mobile Alliance member has agreed to use reasonable endeavors to inform the Open Mobile Alliance in a timely manner of Essential IPR as it becomes aware that the Essential IPR is related to the prepared or published specification. However, the members do not have an obligation to conduct IPR searches. The declared Essential IPR is publicly available to members and non-members of the Open Mobile Alliance and may be found on the “OMA IPR Declarations” list at

    http://www.openmobilealliance.org/ipr.html. The Open Mobile Alliance has not conducted an independent IPR review of

    this document and the information contained herein, and makes no representations or warranties regarding third party IPR, including without limitation patents, copyrights or trade secret rights. This document may contain inventions for which you must obtain licenses from third parties before making, using or selling the inventions. Defined terms above are set forth in the schedule to the Open Mobile Alliance Application Form.

    NO REPRESENTATIONS OR WARRANTIES (WHETHER EXPRESS OR IMPLIED) ARE MADE BY THE OPEN

    MOBILE ALLIANCE OR ANY OPEN MOBILE ALLIANCE MEMBER OR ITS AFFILIATES REGARDING ANY OF

    THE IPR‟S REPRESENTED ON THE “OMA IPR DECLARATIONS” LIST, INCLUDING, BUT NOT LIMITED TO THE

    ACCURACY, COMPLETENESS, VALIDITY OR RELEVANCE OF THE INFORMATION OR WHETHER OR NOT

    SUCH RIGHTS ARE ESSENTIAL OR NON-ESSENTIAL.

    THE OPEN MOBILE ALLIANCE IS NOT LIABLE FOR AND HEREBY DISCLAIMS ANY DIRECT, INDIRECT,

    PUNITIVE, SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR EXEMPLARY DAMAGES ARISING OUT OF OR IN

    CONNECTION WITH THE USE OF DOCUMENTS AND THE INFORMATION CONTAINED IN THE DOCUMENTS.

    ? 2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms set forth above.

     2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

    OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D Page 3 (68) Contents

    1. SCOPE ........................................................................................................................................................................ 7 2. REFERENCES ........................................................................................................................................................... 8 2.1 NORMATIVE REFERENCES ................................................................................................................................... 8 2.2 INFORMATIVE REFERENCES ................................................................................................................................. 8 3. TERMINOLOGY AND CONVENTIONS................................................................................................................. 9 3.1 CONVENTIONS ...................................................................................................................................................... 9 3.2 DEFINITIONS ........................................................................................................................................................ 9 3.3 ABBREVIATIONS ................................................................................................................................................... 9 4. INTRODUCTION .................................................................................................................................................... 11 4.1 VERSION 1.0 ....................................................................................................................................................... 11 5. DEVICE CAPABILITIES API DEFINITION ........................................................................................................ 12 5.1 RESOURCES SUMMARY....................................................................................................................................... 12 5.2 DATA TYPES ....................................................................................................................................................... 17

    5.2.1 XML Namespaces ....................................................................................................................................... 17

    5.2.2 Structures .................................................................................................................................................... 17

    5.2.2.1 Type: DeviceCapabilities .......................................................................................................................................... 17

    5.2.2.2 Type: DeviceCapabilitiesNotification ........................................................................................................................ 17

    5.2.2.3 Type: DeviceCapabilitiesCancellationNotification .................................................................................................... 18

    5.2.2.4 Type: ConfigurationHistoryEntry.............................................................................................................................. 18

    5.2.2.5 Type: DeviceConfigurationHistoryList ...................................................................................................................... 19

    5.2.2.6 Type: DeviceConfiguration ....................................................................................................................................... 19

    5.2.2.7 Type: DeviceConfigurationList ................................................................................................................................. 19

    5.2.2.8 Type: DeviceCapabilitiesChangeSubscriptionList ..................................................................................................... 20

    5.2.2.9 Type: DeviceCapabilitiesChangeSubscription ........................................................................................................... 20

    5.2.3 Enumerations .............................................................................................................................................. 21

    5.2.4 Values of the Link “rel” attribute ................................................................................................................. 21 5.3 SEQUENCE DIAGRAMS ........................................................................................................................................ 22

    5.3.1 Retrieving device capabilities information.................................................................................................... 22

    5.3.2 Subscribing for and notifying on device(s) capabilities ................................................................................. 23

    5.3.3 Pushing a configuration to device(s) ............................................................................................................ 24

    5.3.4 Retrieving available configurations and history of configurations ................................................................. 24 6. DETAILED SPECIFICATION OF THE RESOURCES ........................................................................................ 26 6.1 RESOURCE: DEVICE CAPABILITIES ..................................................................................................................... 26

    6.1.1 Request URL variables ................................................................................................................................ 26

    6.1.2 Response Codes and Error Handling ............................................................................................................ 26

    6.1.3 GET ............................................................................................................................................................ 27

    6.1.3.1 Example: Retrieve device capabilities (Informative) .................................................................................................. 27

    6.1.3.1.1 Request............................................................................................................................................................... 27

    6.1.3.1.2 Response ............................................................................................................................................................ 27

    6.1.4 PUT ............................................................................................................................................................ 27

    6.1.5 POST .......................................................................................................................................................... 27

    6.1.6 DELETE ..................................................................................................................................................... 27 6.2 RESOURCE: SUBSCRIPTIONS FOR DEVICE CAPABILITIES CHANGES NOTIFICATIONS ........................................... 27

    6.2.1 Request URL variables ................................................................................................................................ 28

    6.2.2 Response Codes and Error Handling ............................................................................................................ 28

    6.2.3 GET ............................................................................................................................................................ 28

    6.2.3.1 Example: Retrieve list of subscriptions (Informative) ................................................................................................ 28

    6.2.3.1.1 Request............................................................................................................................................................... 28

    6.2.3.1.2 Response ............................................................................................................................................................ 28

    6.2.4 PUT ............................................................................................................................................................ 29

    6.2.5 POST .......................................................................................................................................................... 29

    6.2.5.1 Example 1: Subscribe to device capabilities changes notifications for single device using ‘tel’ URI (Informative) ....... 29

    6.2.5.1.1 Request............................................................................................................................................................... 29

    6.2.5.1.2 Response ............................................................................................................................................................ 29 2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

    OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D Page 4 (68) 6.2.5.2 Example 2: Subscribe to device capabilities changes notifications for single device using ‘acr’ URI (Informative) ...... 30

    6.2.5.2.1 Request............................................................................................................................................................... 30

    6.2.5.2.2 Response ............................................................................................................................................................ 30 6.2.5.3 Example 3: Subscribe to device capabilities changes notifications for group of devices (Informative) ......................... 31

    6.2.5.3.1 Request............................................................................................................................................................... 31

    6.2.5.3.2 Response ............................................................................................................................................................ 31 6.2.5.4 Example 4: Subscribe to device capabilities changes notifications for single device (with resource reference instead of

    full resource representation in the response body) (Informative) ................................................................................ 32

    6.2.5.4.1 Request............................................................................................................................................................... 32

    6.2.5.4.2 Response ............................................................................................................................................................ 32 6.2.6 DELETE ..................................................................................................................................................... 32 6.3 RESOURCE: INDIVIDUAL SUBSCRIPTION FOR DEVICE CAPABILITIES CHANGES NOTIFICATIONS .......................... 33 6.3.1 Request URL variables ................................................................................................................................ 33 6.3.2 Response Codes and Error Handling ............................................................................................................ 33 6.3.3 GET ............................................................................................................................................................ 33 6.3.3.1 Example: Retrieve subscription (Informative) ........................................................................................................... 33

    6.3.3.1.1 Request............................................................................................................................................................... 33

    6.3.3.1.2 Response ............................................................................................................................................................ 33 6.3.4 PUT ............................................................................................................................................................ 34 6.3.5 POST .......................................................................................................................................................... 34 6.3.6 DELETE ..................................................................................................................................................... 34 6.3.6.1 Example: Delete subscription (Informative) .............................................................................................................. 34

    6.3.6.1.1 Request............................................................................................................................................................... 34

    6.3.6.1.2 Response ............................................................................................................................................................ 34 6.4 RESOURCE: NOTIFICATION ON DEVICE CAPABILITIES CHANGES ........................................................................ 34 6.4.1 Request URL variables ................................................................................................................................ 34 6.4.2 Response Codes and Error Handling ............................................................................................................ 35 6.4.3 GET ............................................................................................................................................................ 35 6.4.4 PUT ............................................................................................................................................................ 35 6.4.5 POST .......................................................................................................................................................... 35 6.4.5.1 Example 1: Device capabilities changes notification (Informative)............................................................................ 35

    6.4.5.1.1 Request............................................................................................................................................................... 35

    6.4.5.1.2 Response ............................................................................................................................................................ 35 6.4.5.2 Example 2: End of changes notification (Informative) ............................................................................................... 36

    6.4.5.2.1 Request............................................................................................................................................................... 36

    6.4.5.2.2 Response ............................................................................................................................................................ 36 6.4.5.3 Example 3: Error notification (notification cancellation) (Informative) ...................................................................... 36

    6.4.5.3.1 Request............................................................................................................................................................... 36

    6.4.5.3.2 Response ............................................................................................................................................................ 37 6.4.6 DELETE ..................................................................................................................................................... 37 6.5 RESOURCE: DEVICE CONFIGURATION ................................................................................................................ 37 6.5.1 Request URL variables ................................................................................................................................ 37 6.5.2 Response Codes and Error Handling ............................................................................................................ 37 6.5.3 GET ............................................................................................................................................................ 38 6.5.4 PUT ............................................................................................................................................................ 38 6.5.5 POST .......................................................................................................................................................... 38 6.5.5.1 Example 1: Push configuration to single device (Informative) .................................................................................... 38

    6.5.5.1.1 Request............................................................................................................................................................... 38

    6.5.5.1.2 Response ............................................................................................................................................................ 38 6.5.5.2 Example 2: Push configuration to group of devices (Informative) .............................................................................. 38

    6.5.5.2.1 Request............................................................................................................................................................... 38

    6.5.5.2.2 Response ............................................................................................................................................................ 39 6.5.6 DELETE ..................................................................................................................................................... 39 6.6 RESOURCE: AVAILABLE CONFIGURATIONS ........................................................................................................ 39 6.6.1 Request URL variables ................................................................................................................................ 39 6.6.2 Response Codes and Error Handling ............................................................................................................ 39 6.6.3 GET ............................................................................................................................................................ 39 6.6.3.1 Example: Retrieve available device configurations (Informative) ............................................................................... 39

    6.6.3.1.1 Request............................................................................................................................................................... 39

    6.6.3.1.2 Response ............................................................................................................................................................ 40 6.6.4 PUT ............................................................................................................................................................ 40

     2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

    OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D Page 5 (68)

    6.6.5 POST .......................................................................................................................................................... 40

    6.6.6 DELETE ..................................................................................................................................................... 40 6.7 RESOURCE: CONFIGURATION HISTORY .............................................................................................................. 40

    6.7.1 Request URL variables ................................................................................................................................ 41

    6.7.2 Response Codes and Error Handling ............................................................................................................ 41

    6.7.3 GET ............................................................................................................................................................ 41

    6.7.3.1 Example: Retrieve configuration history (Informative) .............................................................................................. 41

    6.7.3.1.1 Request............................................................................................................................................................... 41

    6.7.3.1.2 Response ............................................................................................................................................................ 41

    6.7.4 PUT ............................................................................................................................................................ 42

    6.7.5 POST .......................................................................................................................................................... 42

    6.7.6 DELETE ..................................................................................................................................................... 42 7. FAULT DEFINITIONS ............................................................................................................................................ 43 7.1 SERVICE EXCEPTIONS ........................................................................................................................................ 43 7.2 POLICY EXCEPTIONS .......................................................................................................................................... 43 APPENDIX A. CHANGE HISTORY (INFORMATIVE).......................................................................................... 44 A.1 APPROVED VERSION HISTORY ........................................................................................................................... 44 A.2 DRAFT/CANDIDATE VERSION 1.0 HISTORY ........................................................................................................ 44 APPENDIX B. STATIC CONFORMANCE REQUIREMENTS (NORMATIVE) .................................................. 46 B.1 SCR FOR REST.DEVCAP SERVER ..................................................................................................................... 46

    B.1.1 SCR for REST.DevCap.AccCap Server ....................................................................................................... 46

    B.1.2 SCR for REST.DevCap.List.Subscr Server .................................................................................................. 46

    B.1.3 SCR for REST.DevCap.Individual.Subscr Server ......................................................................................... 46

    B.1.4 SCR for REST.DevCap.Notif Server............................................................................................................ 47

    B.1.5 SCR for REST.DevCap.AccConfig Server ................................................................................................... 47 APPENDIX C. APPLICATION/X-WWW-FORM-URLENCODED REQUEST FORMAT FOR POST

    OPERATIONS (NORMATIVE) ........................................................................................................ 48 C.1 START DEVICE CAPABILITIES CHANGES NOTIFICATIONS ...................................................................................... 48

    C.1.1 Example 1, using ‘tel’ URI (Informative) ......................................................................................... 49

    C.1.1.1 Request .................................................................................................................................................................... 49

    C.1.1.2 Response .................................................................................................................................................................. 49

    C.1.2 Example 2, using ‘acr’ URI (Informative) ........................................................................................ 49

    C.1.2.1 Request .................................................................................................................................................................... 49

    C.1.2.2 Response .................................................................................................................................................................. 50 C.2 PUSH A CONFIGURATION TO A DEVICE ............................................................................................................... 50

    C.2.1 Example (Informative)........................................................................................................................ 50

    C.2.1.1 Request ............................................................................................................................................................. 50

    C.2.1.2 Response .......................................................................................................................................................... 51 APPENDIX D. JSON EXAMPLES (INFORMATIVE) ............................................................................................ 52 D.1 RETRIEVE DEVICE CAPABILITIES (SECTION 6.1.3.1) ........................................................................................... 52 D.2 RETRIEVE LIST OF SUBSCRIPTIONS (SECTION 6.2.3.1) ......................................................................................... 52 D.3 SUBSCRIBE TO DEVICE CAPABILITIES CHANGES NOTIFICATIONS FOR SINGLE DEVICE USING TEL URI (SECTION

    6.2.5.1) ............................................................................................................................................................... 53 D.4 SUBSCRIBE TO DEVICE CAPABILITIES CHANGES NOTIFICATIONS FOR SINGLE DEVICE USING ACR URI (SECTION

    6.2.5.2) ............................................................................................................................................................... 54 D.5 RETRIEVE SUBSCRIPTION (SECTION 6.3.3.1) ....................................................................................................... 54 D.6 DELETE SUBSCRIPTION (SECTION 6.3.6.1) .......................................................................................................... 55 D.7 DEVICE CAPABILITIES CHANGES NOTIFICATION (SECTION 6.4.5.1)..................................................................... 55 D.8 END OF CHANGES NOTIFICATION (SECTION 6.4.5.2)............................................................................................ 56 D.9 ERROR NOTIFICATION (NOTIFICATION CANCELLATION) (SECTION 6.4.5.3) ........................................................ 57 D.10 PUSH CONFIGURATION TO SINGLE DEVICE (SECTION 6.5.5.1) ............................................................................. 57

    D.11 RETRIEVE AVAILABLE DEVICE CONFIGURATIONS (SECTION 6.6.3.1) .................................................................. 58

    D.12 RETRIEVE CONFIGURATION HISTORY (SECTION 6.7.3.1)..................................................................................... 59 APPENDIX E. PARLAY X OPERATIONS MAPPING (INFORMATIVE) ............................................................ 61 APPENDIX F. LIGHT-WEIGHT RESOURCES (INFORMATIVE) ....................................................................... 62 2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

    OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D Page 6 (68) APPENDIX G. AUTHORIZATION ASPECTS (NORMATIVE) ............................................................................. 63 G.1 USE WITH OMA AUTHORIZATION FRAMEWORK FOR NETWORK APIS.............................................................. 63

    G.1.1 Scope values ............................................................................................................................................... 63

    G.1.1.1 Definitions ............................................................................................................................................................... 63

    G.1.1.2 Downscoping ........................................................................................................................................................... 63

    G.1.1.3 Mapping with resources and methods ....................................................................................................................... 64

    G.1.2 Use of „acr:Authorization‟ ........................................................................................................................... 67

    Figures

    Figure 1 Resource structure defined by this specification ............................................................................................... 13 Figure 2 Retrieving device capabilities ............................................................................................................................ 22 Figure 3 Subscribing for change notifications and handling notifications ...................................................................... 23 Figure 4 Push configuration to device(s) .......................................................................................................................... 24 Figure 5 Retrieving available configurations or configuration history for targeted device ............................................ 25 Tables

    Table 1: Parlay X operations mapping ............................................................................................................................ 61 Table 2: Scope values for RESTful Device Capabilities API ........................................................................................... 63 Table 3: Required scope values for: Device capabilities .................................................................................................. 65 Table 4: Required scope values for: Subscription Management for device capabilities changes ................................... 65 Table 5: Required scope values for: Retrieving configuration (available or history) and pushing a configuration ....... 66

     2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D Page 7 (68)

    1. Scope

    This specification defines a RESTful Device Capabilities API using an HTTP protocol binding, based on the similar API

    defined in [3GPP 29.199-18].

     2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D Page 8 (68)

    2. References

    2.1 Normative References

    3GPP Technical Specification, “Open Service Access (OSA); Parlay X Web Services; Part 18: Device [3GPP 29.199-18]

    capabilities and configuration (Release 8)”, URL:http://www.3gpp.org/

    “Authorization Framework for Network APIs”, Open Mobile Alliance?, OMA-ER-Autho4API-V1_0, [Autho4API_10]

    URL: http://www.openmobilealliance.org/

    “The acr URI for anonymous users”, S.Jakobsson, K.Smith, July 2011, URL: [IETF_ACR_draft] http://tools.ietf.org/html/draft-uri-acr-extension-03

    “Common definitions for RESTful Network APIs”, Open Mobile Alliance?, OMA-TS-[REST_NetAPI_Commo

    REST_NetAPI_Common-V1_0, URL: http://www.openmobilealliance.org/ n]

    “RESTful Network API for Notification Channel”, Open Mobile Alliance?, OMA-TS-[REST_NetAPI_Notifica

    REST_NetAPI_NotificationChannel-V1_0, URL: http://www.openmobilealliance.org/ tionChannel]

    “XML schema for the RESTful Network API for Device Capabilities”, Open Mobile Alliance?, OMA-[REST_SUP_DeviceCap

    SUP-XSD_rest_netapi_devicecapabilities-V1_0, URL:http://www.openmobilealliance.org/ abilities]

    “Key words for use in RFCs to Indicate Requirement Levels”, S. Bradner, March 1997, [RFC2119] URL:http://www.ietf.org/rfc/rfc2119.txt

    “Hypertext Transfer Protocol -- HTTP/1.1”, R. Fielding et. al, January 1999, [RFC2616]

    URL:http://www.ietf.org/rfc/rfc2616.txt

     “SIP: Session Initiation Protocol”, J. Rosenberg et al., June 2002, URL: http://www.rfc-[RFC3261]

    editor.org/rfc/rfc3261.txt

    “The tel URI for Telephone Numbers”, H.Schulzrinne, December 2004, URL: [RFC3966]

    http://www.ietf.org/rfc/rfc3966.txt

    Uniform Resource Identifier (URI): Generic Syntax”, R. Fielding et. al, January 2005, [RFC3986] URL:http://www.ietf.org/rfc/rfc3986.txt

    “The application/json Media Type for JavaScript Object Notation (JSON)”, D. Crockford, July 2006, [RFC4627]

    URL: http://www.ietf.org/rfc/rfc4627.txt

    “SCR Rules and Procedures”, Open Mobile Alliance?, OMA-ORG-SCR_Rules_and_Procedures, [SCRRULES]

    URL:http://www.openmobilealliance.org/

    HTML 4.01 Specification, Section 17.13.4 Form content types, The World Wide Web Consortium, URL: [W3C_URLENC]

    http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1

    W3C Recommendation, XML Schema Part 1: Structures Second Edition, URL: [XMLSchema1] http://www.w3.org/TR/xmlschema-1/

    W3C Recommendation, XML Schema Part 2: Datatypes Second Edition, URL: [XMLSchema2] http://www.w3.org/TR/xmlschema-2/

    2.2 Informative References

    “Dictionary for OMA Specifications”, Version 2.8, Open Mobile Alliance?, [OMADICT] OMA-ORG-Dictionary-V2_8, URL:http://www.openmobilealliance.org/ [ParlayREST_DeviceCa“RESTful bindings for Parlay X Web Services DeviceCapabilities”, Version 1.0, Open Mobile pabilities] Alliance?, OMA-TS-ParlayREST_DeviceCapabilities-V1_0

    “Guidelines for RESTful Network APIs”, Open Mobile Alliance?, OMA-WP-[REST_WP] Guidelines_for_RESTful_Network_APIs, URL:http://www.openmobilealliance.org/ 2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

    OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D Page 9 (68) 3. Terminology and Conventions 3.1 Conventions

    The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”,

    “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC2119].

    All sections and appendixes, except “Scope” and “Introduction”, are normative, unless they are explicitly indicated to be

    informative.

    3.2 Definitions

    For the purpose of this TS, all definitions from the OMA Dictionary apply [OMADICT].

    Client-side An HTTP URL exposed by a client, on which it is capable of receiving notifications and that can be used by the Notification client when subscribing to notifications. URL

    Long Polling A variation of the traditional polling technique, where the server does not reply to a request unless a particular event,

    status or timeout has occurred. Once the server has sent a response, it closes the connection, and typically the client

    immediately sends a new request. This allows the emulation of an information push from a server to a client.

    Notification A channel created on the request of the client and used to deliver notifications from a server to a client. The channel Channel is represented as a resource and provides means for the server to post notifications and for the client to receive them

    via specified delivery mechanisms.

    For example in the case of Long Polling the channel resource is defined by a pair of URLs. One of the URLs is used

    by the client as a call-back URL when subscribing for notifications. The other URL is used by the client to retrieve

    notifications from the Notification Server.

    Notification A server that is capable of creating and maintaining Notification Channels. Server

    Server-side An HTTP URL exposed by a Notification Server, that identifies a Notification Channel and that can be used by a Notification client when subscribing to notifications. URL

3.3 Abbreviations

    Anonymous Customer Reference ACR

    Application Programming Interface API

    HyperText Transfer Protocol HTTP

    Identifier ID

    International Mobile Equipment Identity IMEI

    JavaScript Object Notation JSON

    Multipurpose Internet Mail Extensions MIME

    Mobile Subscriber ISDN Number MSISDN

    Open Mobile Alliance OMA

    REpresentational State Transfer REST

    Static Conformance Requirements SCR

    SIP Session Initiation Protocol

    Technical Specification TS

    User Agent Profile UAProfile

    Uniform Resource Identifier URI

     2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

    OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D Page 10 (68)

    Uniform Resource Locator URL

    eXtensible Markup Language XML

    XML Schema Definition XSD

     2012 Open Mobile Alliance Ltd. All Rights Reserved.

    Used with the permission of the Open Mobile Alliance Ltd. under the terms as stated in this document. [OMA-Template-Spec-20120101-I]

Report this document

For any questions or suggestions please email
cust-service@docsford.com