Skip to main content
Jump to: navigation, search

OM2M/Subscriptions

< OM2M
Revision as of 04:54, 17 April 2014 by Ybanouar.laas.fr (Talk | contribs) (Created page with "__TOC__ == Subscriptions resource == The subscriptions resource is a collection of subscription resources, it is a child of a subscribe-able parent. {...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Subscriptions resource

The subscriptions resource is a collection of subscription resources, it is a child of a subscribe-able parent.


Attribute Name Type Multiplicity Create Update Response
subscriptionCollection NamedReferenceCollection 0..unbounded N/A NP M

Subscriptions representation

<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://uri.etsi.org/m2m" xmlns:tns="http://uri.etsi.org/m2m">
	<include schemaLocation="common.xsd" />	
	<element name="subscriptions" type="tns:Subscriptions" />
	<complexType name="Subscriptions">
		<sequence>
			<!-- subresources -->
			<element ref="tns:subscriptionCollection" minOccurs="0" />
		</sequence>
	</complexType>
	<element name="subscriptionCollection" type="tns:NamedReferenceCollection" />
</schema>

Create Subscriptions

The Subscriptions resource shall not be created via the API, it is created as a part of the parent resource.

Retrieve Subscriptions

Retrieve information about accessible resources

  • Synopsis: GET {Well Known URI of the Service}
  • Request Headers: Authorization, Accept.
  • Request Body: N/A.
  • Response Headers: Content-Type, Content-Length.
  • Response Message Body: Subscriptions.
  • Response Status: 200, 402, 404, 501.

Example Request

GET /scl-id/applications/subscriptions
Host: om2m.laas.fr
Authorization: Basic xxxxxxxxxxxxxxxxxxx

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<om2m:subscriptions xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
    <om2m:subscriptionCollection>
        <om2m:namedReference id="SUB_357975768">scl-id/applications/subscriptions/SUB_357975768</om2m:namedReference>
    </om2m:subscriptionCollection>
</om2m:subscriptions>

Update Subscriptions

The subscriptions resource doesn't have any updatable attribute.

Delete Subscriptions

The subscriptions resource shall not be deleted via the API. It is deleted when the parent resource is deleted.

Back to the top