DOC

OMA-TS-REST_NetAPI_DeviceCapabilities-V1_0-20121002-D

By Betty Price,2014-09-12 23:03
12 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) ........................................................................