Difference between revisions of "OM2M/Groups"

Revision as of 05:56, 17 April 2014

Groups resource

The groups resource is a collection of group resources and/or groupAnnc resources. It can reside in the following targets:

• < sclBase>/ groups: contains only local group resources.
• < sclBase>/ scls/< scl>/ groups: contains groupAnnc resource announced by a group resource in the remote < scl>.
• < sclBase>/ applications/< app>/ groups: contains only group resource created by the application corresponding to < app>.
• < sclBase>/ scls/< scl>/ applications/< applicationAnnc>/ groups: contains only groupAnnc resource representing the announcement of a group resource residing in the remote < scl>.

Groups 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="groups" type="tns:Groups" />
  <complexType name="Groups">
    <all>
      <element ref="tns:accessRightID" minOccurs="0"/>
      <element ref="tns:creationTime" minOccurs="0"/>
      <element ref="tns:lastModifiedTime" minOccurs="0"/>
      <!-- subresources -->
      <element ref="tns:groupCollection" minOccurs="0" />
      <element ref="tns:groupAnncCollection" minOccurs="0" />
      <element ref="tns:subscriptionsReference" minOccurs="0"/>
    </all>
  </complexType>
  <element name="groupCollection" type="tns:NamedReferenceCollection" />
  <element name="groupAnncCollection" type="tns:NamedReferenceCollection" />
</schema>

Create Groups

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

Retrieve Groups

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

Example Request

GET /scl-id/groups
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:groups xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
    <om2m:accessRightID>scl-id/accessRights/AR_ADMIN</om2m:accessRightID>
    <om2m:creationTime>2014-04-14T22:03:50.667+02:00</om2m:creationTime>
    <om2m:lastModifiedTime>2014-04-14T22:03:50.686+02:00</om2m:lastModifiedTime>
    <om2m:groupCollection>
        <om2m:namedReference id="GROUP_ON">scl-id/groups/GROUP_ON</om2m:namedReference>
        <om2m:namedReference id="GROUP_OFF">scl-id/groups/GROUP_OFF</om2m:namedReference>
    </om2m:groupCollection>
    <om2m:groupAnncCollection/>
    <om2m:subscriptionsReference>scl-id/groups/subscriptions</om2m:subscriptionsReference>
</om2m:groups>

Update Groups

Update information about accessible resources

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

Example Request

PUT /scl-id/groups
Host: om2m.laas.fr
Authorization: Basic xxxxxxxxxxxxxxxxxxx

<?xml version="1.0" encoding="UTF-8"?>
<om2m:groups xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
    <om2m:accessRightID>scl-id/accessRights/AR_ADMIN_2</om2m:accessRightID>
</om2m:groups>

Example Response

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<om2m:groups xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
    <om2m:accessRightID>scl-id/accessRights/AR_ADMIN_2</om2m:accessRightID>
    <om2m:creationTime>2014-04-14T22:03:50.667+02:00</om2m:creationTime>
    <om2m:lastModifiedTime>2014-04-14T22:04:36.627+02:00</om2m:lastModifiedTime>
    <om2m:groupCollection>
        <om2m:namedReference id="GROUP_ON">scl-id/groups/GROUP_ON</om2m:namedReference>
        <om2m:namedReference id="GROUP_OFF">scl-id/groups/GROUP_OFF</om2m:namedReference>
    </om2m:groupCollection>
    <om2m:groupAnncCollection/>
    <om2m:subscriptionsReference>scl-id/groups/subscriptions</om2m:subscriptionsReference>
</om2m:groups>

Delete Groups

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