Skip to main content
Jump to: navigation, search

Difference between revisions of "OM2M/ApplicationAnnc"

(ApplicationAnnc delete)
(ApplicationAnnc retrieve)
Line 53: Line 53:
  
 
== ApplicationAnnc retrieve ==
 
== ApplicationAnnc retrieve ==
 +
 +
'''Retrieve information about an ApplicationAnnc resource'''
 +
 +
* 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: GroupAnnc.
 +
* Response Status: 200, 402, 404, 501.
 +
 +
'''Example Request'''
 +
 +
<pre>
 +
GET /scl-id/scls/scl-id2/applications/applicationsAnnc/app-IdAnnc
 +
Host: om2m.laas.fr
 +
Authorization: Basic xxxxxxxxxxxxxxxxxxx
 +
</pre>
 +
 +
'''Example Response'''
 +
 +
<pre>
 +
HTTP/1.1 200 OK
 +
Content-Type: text/xml
 +
 +
</pre>
  
 
== ApplicationAnnc update ==
 
== ApplicationAnnc update ==

Revision as of 06:44, 18 April 2014

ApplicationAnnc resource

This ApplicationAnnc resource represents an active announcement of a registered application in another SCL. It keeps a link to the original resource.

This resource contains sub-resources for containers, groups, accessRights collection resources which enable the creation of these type of resources whith a lifetime and scope associated to the announced parent resource. I.e The Created sub-resources will automatically be deleted when the application is de-announced or at announcement expiration.

Attribute Name Type Multiplicity Create Update Response
link AnyURI 1 M NP M
accessRightID AnyURI 0..1 O O O
searchStrings searchStrings 1 M M M
expirationTime DateTime 1 O O M*
id NMTOKEN 1 O NP M*
containersReference AnyURI 1 NP NP M
groupsReference AnyURI 1 NP NP M
accessRightsReference AnyURI 1 NP NP M

ApplicationAnnc 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="applicationAnnc" type="tns:ApplicationAnnc" />
  <complexType name="ApplicationAnnc">
    <all>
      <element ref="tns:link" />
      <element ref="tns:accessRightID" minOccurs="0" />
      <element ref="tns:searchStrings" minOccurs="0" />
      <element ref="tns:expirationTime" minOccurs="0" />
      <!-- subresources -->
      <element ref="tns:containersReference" minOccurs="0" />
      <element ref="tns:groupsReference" minOccurs="0" />
      <element ref="tns:accessRightsReference" minOccurs="0" />
    </all>
    <attribute name="id" type="anyURI"/>
  </complexType>
</schema>

ApplicationAnnc create

This resource shall not be created via the API. It is created only as a result of a remote announcable resource announcement.

ApplicationAnnc retrieve

Retrieve information about an ApplicationAnnc resource

  • 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: GroupAnnc.
  • Response Status: 200, 402, 404, 501.

Example Request

GET /scl-id/scls/scl-id2/applications/applicationsAnnc/app-IdAnnc
Host: om2m.laas.fr
Authorization: Basic xxxxxxxxxxxxxxxxxxx

Example Response

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

ApplicationAnnc update

This resource shall not be updated via the API. It is updated only as a result of a remote announcable resource update.

ApplicationAnnc delete

This resource shall not be deleted via the API. It is deleted only as a result of a remote announcable resource de-announcement.

Back to the top