[
http://jira.amdatu.org/jira/browse/AMDATUOPENSOCIAL-204?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12753#comment-12753
]
Ivo Ladage - van Doorn edited comment on AMDATUOPENSOCIAL-204 at 2/27/12 11:29
AM:
-----------------------------------------------------------------------------------
Global description of the new API:
GET /rest/gadgets
Returns all gadgets from the store.
GET /rest/gadgets/{categoryid}
Returns all gadgets from the store in the specified category.
PUT /rest/gadgets/{categoryid}
Form params: id, name
Creates a new or overwrites an existing category.
DELETE /rest/gadgets/{categoryid}
Deletes an existing category
POST /rest/gadgets/{categoryid}
Form parameter: url
Appends a gadget to the store in the specified category. If the category
already contains a gadget with this URL, this method returns a 200 (ok).
Otherwise it returns a 201 (created). The id of the gadget is calculated from
the url (hash).
GET /rest/gadgets/{categoryid}/{gadgetid}
Returns the properties of a single gadget
PUT /rest/gadgets/{categoryid}/{gadgetid}
Form parameter: url
Creates or overwrites the gadget with the specified url in this category.
DELETE /rest/gadgets/{categoryid}/{gadgetid}
Deletes a gadget from the category.
XML returned by GET /rest/gadgets:
{code:xml}
<gadgets>
<categories>
<category>
<id>wheather</id>
<name>Wheather</name>
<gadgets>
<size>0</size>
</gadgets>
</category>
<category>
<id>news</id>
<name>News</name>
<gadgets>
<size>1</size>
<gadget>
<id>GKD7823ND93</id>
<url>http://gadgets.nu.nl/nuzakelijk_igoogle.xml</url>
<specification>
<title>NUzakelijk</title>
<screenshot>http://gadgets.nu.nl/images/nuzakelijk_screen.png</screenshot>
<description>De officiële gadget van NUzakelijk.nl:
bekijk...</description>
<author>NU.nl</author>
<authoremail></authoremail>
<authoraffiliation></authoraffiliation>
<titleurl>http://www.nuzakelijk.nl/</titleurl>
<height>350</height>
</specification>
</gadget>
</gadgets>
</category>
</categories>
</gadgets>
{code}
was (Author: ivol):
Global description of the new API:
GET /rest/gadgets
Returns all gadgets from the store.
GET /rest/gadgets/{categoryid}
Returns all gadgets from the store in the specified category.
PUT /rest/gadgets/{categoryid}
Form params: id, name
Creates a new or overwrites an existing category.
DELETE /rest/gadgets/{categoryid}
Deletes an existing category
POST /rest/gadgets/{categoryid}
Form parameter: url
Appends a gadget to the store in the specified category. If the category
already contains a gadget with this URL, this method returns a 200 (ok).
Otherwise it returns a 201 (created). The id of the gadget is calculated from
the url (hash).
GET /rest/gadgets/{categoryid}/{gadgetid}
Returns the properties of a single gadget
PUT /rest/gadgets/{categoryid}/{gadgetid}
Form parameter: url
Creates or overwrites the gadget with the specified url in this category.
DELETE /rest/gadgets/{categoryid}/{gadgetid}
Deletes a gadget from the category.
XML returned by GET /rest/gadgets:
<gadgets>
<categories>
<category>
<id>wheather</id>
<name>Wheather</name>
<gadgets>
<size>0</size>
</gadgets>
</category>
<category>
<id>news</id>
<name>News</name>
<gadgets>
<size>1</size>
<gadget>
<id>GKD7823ND93</id>
<url>http://gadgets.nu.nl/nuzakelijk_igoogle.xml</url>
<specification>
<title>NUzakelijk</title>
<screenshot>http://gadgets.nu.nl/images/nuzakelijk_screen.png</screenshot>
<description>De officiële gadget van NUzakelijk.nl:
bekijk...</description>
<author>NU.nl</author>
<authoremail></authoremail>
<authoraffiliation></authoraffiliation>
<titleurl>http://www.nuzakelijk.nl/</titleurl>
<height>350</height>
</specification>
</gadget>
</gadgets>
</category>
</categories>
</gadgets>
> Improve Gadget store REST API
> ------------------------------
>
> Key: AMDATUOPENSOCIAL-204
> URL: http://jira.amdatu.org/jira/browse/AMDATUOPENSOCIAL-204
> Project: Amdatu OpenSocial
> Issue Type: Improvement
> Components: Gadget management
> Affects Versions: 0.2.0
> Reporter: Ivo Ladage - van Doorn
> Assignee: Ivo Ladage - van Doorn
> Fix For: 0.2.1
>
>
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
http://jira.amdatu.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
_______________________________________________
Amdatu-developers mailing list
[email protected]
http://lists.amdatu.org/mailman/listinfo/amdatu-developers
