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

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

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'''

The [http://www.freedesktop.org/wiki/Specifications/open-collaboration-services#head-bc4b00b0f4e7121df53cdd3a8d0c71a62b30a465 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 [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

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'''

* Adding details to the list component, like screen-shot and contributors (bergie)
* Adding sorting features to the list (date, karma, rating, alphabetical)
* Remove ratings from 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]]

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

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

Personal tools

Navigation

Views

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

@@ Line 45: / Line 45: @@
 * '''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:
@@ Line 81: / Line 80: @@
 '''NEXT STEPS'''
-* separate ratings and comments
+* Adding details to the list component, like screen-shot and contributors (bergie)
+* Adding sorting features to the list (date, karma, rating, alphabetical)
+* Remove ratings from comments