Task:Download client for extras-applications/REST-API

(New page: The REST-API to fetch the content is based on the content part of the [http://www.freedesktop.org/wiki/Specifications/open-collaboration-services open collaboration services API]. Right no...)
(categorize)
 
(6 intermediate revisions not shown)
Line 1: Line 1:
The REST-API to fetch the content is based on the content part of the [http://www.freedesktop.org/wiki/Specifications/open-collaboration-services open collaboration services API]. Right now the following calls are implemented:
The REST-API to fetch the content is based on the content part of the [http://www.freedesktop.org/wiki/Specifications/open-collaboration-services open collaboration services API]. Right now the following calls are implemented:
 +
 +
 +
'''CATEGORIES'''
'''CATEGORIES'''
Line 30: Line 33:
     </data>
     </data>
  </ocs>
  </ocs>
 +
 +
 +
'''LIST'''
'''LIST'''
 +
 +
The idea of this call is to get a list regarding to the arguments, given in the [http://www.freedesktop.org/wiki/Specifications/open-collaboration-services#head-bece9f40fa226bfd6dab67769e1750925a416f95-2 specification]. The following arguments are implemented:
 +
 +
* '''search''': searches for a specified keyword
 +
* '''categories''': filters the list by the specified category
 +
* '''page''': content page
 +
* '''pagesize''': items per page
 +
* '''sortmode''': Possible values are: "new" - newest first , "alpha" - alphabetical, "high" - highest rated, "down" - most downloads
 +
 +
Further the list of fields, which are returned by the request are the ones you find in the example:
 +
 +
<?xml version="1.0"?>
 +
<ocs>
 +
    <meta>
 +
        <status>ok</status>
 +
        <message></message>
 +
        <totalitems>1</totalitems>
 +
    </meta>
 +
    <data>
 +
        <content>
 +
            <id>id</id>
 +
            <name>name</name>
 +
            <version>1.0</version>
 +
            <changed>2009-05-06T12:05:13+0000</changed>
 +
            <created>2009-05-06T12:05:13+0000</created>
 +
            <downloads>0</downloads>
 +
            <score>0</score>
 +
            <comments>0</comments>
 +
        </content>
 +
    </data>
 +
</ocs>
 +
 +
 +
 +
'''GET'''
 +
 +
The get-method is not based on the [http://www.freedesktop.org/wiki/Specifications/open-collaboration-services#head-8adf4754e5f65b3d851400de09c52409f7a15031-5 specification] yet. Work is ongoing.
 +
 +
 +
 +
 +
'''NEXT STEPS'''
 +
 +
* separate ratings and comments
 +
 +
 +
 +
'''Open issues'''
 +
 +
Related to the [[Task:Single_sign-on | SSO]] task is the question on how to implement the features, where a log-in is required, like personal rating and commenting. One suggestion would be to use the [http://www.salmon-protocol.org/ salmon protocol] for that. But this is still work in progress.
 +
 +
[[Category:Tasks]]

Latest revision as of 08:20, 11 May 2010

The REST-API to fetch the content is based on the content part of the open collaboration services API. Right now the following calls are implemented:



CATEGORIES

The categories API is fully implemented. An example for the OS2008:

.../categories?parent=OS2008 : 

<?xml version="1.0"?>
<ocs>
   <meta>
       <status>ok</status>
       <message></message>
       <totalitems>16</totalitems>
   </meta>
   <data>
       <category>
           <id>id</id>
           <name>Multimedia</name>
       </category>
       <category>
           <id>id</id>
           <name>Games</name>
       </category>
       ...
       <category>
           <id>id</id>
           <name>Travel</name>
       </category>
   </data>
</ocs>



LIST

The idea of this call is to get a list regarding to the arguments, given in the specification. The following arguments are implemented:

  • search: searches for a specified keyword
  • categories: filters the list by the specified category
  • page: content page
  • pagesize: items per page
  • sortmode: Possible values are: "new" - newest first , "alpha" - alphabetical, "high" - highest rated, "down" - most downloads

Further the list of fields, which are returned by the request are the ones you find in the example: 

<?xml version="1.0"?>
<ocs>
   <meta>
       <status>ok</status>
       <message></message>
       <totalitems>1</totalitems>
   </meta>
   <data>
       <content>
           <id>id</id>
           <name>name</name>
           <version>1.0</version>
           <changed>2009-05-06T12:05:13+0000</changed>
           <created>2009-05-06T12:05:13+0000</created>
           <downloads>0</downloads>
           <score>0</score>
           <comments>0</comments>
       </content>
   </data>
</ocs>


GET

The get-method is not based on the specification yet. Work is ongoing.



NEXT STEPS

  • separate ratings and comments


Open issues

Related to the SSO task is the question on how to implement the features, where a log-in is required, like personal rating and commenting. One suggestion would be to use the salmon protocol for that. But this is still work in progress.

Retrieved from "http://bugs.maemo.org/Task:Download_client_for_extras-applications/REST-API"