Methods
From Ma.gnolia Community Wiki
Contents |
echo
http://ma.gnolia.com/api/rest/1/echo
This method simply echos back any parameters you send. This method does not require an Application Access Key.
Parameters
Any
Returns
A list of parameters and values.
Example Response
<response status="ok" version="1"> <parameter1>value1</parameter1> <parameter2>value2</parameter2> </response>
bookmarks_get
http://ma.gnolia.com/api/rest/1/bookmarks_get
Returns a list of one or more bookmarks matching specified screen names.
Parameters
id=[bookmarks] : The short name for one or more bookmarks.
Returns
A list of bookmarks.
Example Response
<response status="ok" version="1">
<bookmarks>
<bookmark id="scublebux" created="2006-03-02T02:26:59Z" updated="2006-03-02T02:26:59Z" rating="5" private="false" owner="cooluser">
<title>Ma.gnolia</title>
<url>http://ma.gnolia.com/</url>
<description>Visit Ma.gnolia.com to learn about social bookmarking with our bookmark manager and our worldwide online information community.</description>
<screenshot>http://scsin.srv.girafa.com/srv/i?i=sc010159&r=http://ma.gnolia.com/&s=af476092a75a7f3e</screenshot>
<tags>
<tag name="cool" />
<tag name="cats" />
<tag name="rool" />
</tags>
</bookmark>
...
</bookmarks>
</response>
bookmarks_find
http://ma.gnolia.com/api/rest/1/bookmarks_find
Returns a list of bookmarks matching specified search parameters.
Parameters
tags=[tags] : Multiple tags are treated as an AND search
person=[members] : Multiple screen names are treated as an ‘OR’ search
group=[groups] : Multiple groups are treated as an ‘OR’ search
rating=[1-5] : Only bookmarks rated this value or higher will be returned.
from=[datetime] : Only bookmarks created after this date time will be returned.
to=[datetime] : Only bookmarks created before this date time will be returned.
url=[string] : Only return bookmarks with this url.
limit=[integer] : A maximum number of bookmarks to return from search.
Returns
A list of bookmarks.
Example Response
See bookmarks_get above.
bookmarks_count
http://ma.gnolia.com/api/rest/1/bookmarks_count
Returns a count of the total number of bookmarks matching specified search parameters.
Parameters
tags=[tags] : Multiple tags are treated as an AND search
person=[members] : Multiple screen names are treated as an ‘OR’ search
group=[groups] : Multiple groups are treated as an ‘OR’ search
rating=[1-5] : Only bookmarks rated this value or higher will be returned.
from=[datetime] : Only bookmarks created after this date time will be returned.
to=[datetime] : Only bookmarks created before this date time will be returned.
url=[string] : Only return bookmarks with this url.
limit=[integer] : A maximum number of bookmarks to return from search.
Returns
An integer.
Example Response
<response status="ok" version="1"> <count>10</count> </response>
bookmarks_delete
''http://ma.gnolia.com/api/rest/1/bookmarks_delete''
Deletes one or more specified bookmarks. The delete action cannot be undone, so please provide adequate user confirmation steps.
Parameters
id=[bookmarks] : The short name for one or more bookmarks to be deleted.
Returns A list of bookmarks in condensed format with only the short names of the bookmarks that were deleted.
Example Response
<response status="ok" version="1">
<bookmarks>
<bookmark id="scublebux"></bookmark>
...
</bookmarks>
</response>
bookmarks_add
http://ma.gnolia.com/api/rest/1/bookmarks_add
Parameters
title=[string] : A title string.
description=[string] : A description string.
url=[url] : A URL string. Must be valid.
private=[1|0] : The bookmark’s privacy status.
tags=[tags] : A list of tags. This will completely replace any existing tags for each specified bookmark.
rating = [0 .. 5]. An integer representing a star rating.
Returns
A bookmark list with one item, the added bookmark.
Example Response
See bookmarks_get above.
bookmarks_update
http://ma.gnolia.com/api/rest/1/bookmarks_update
The update action cannot be undone, so please provide adequate user confirmation steps.
Parameters
id= [bookmark] : The short name for one bookmark
title=[string] : A title string.
description=[string] : A description string.
url=[url] : A URL string. Must be valid.
private=[true|false] : The bookmark’s privacy status.
tags=[tags] : A list of tags. This will completely replace any existing tags for each specified bookmark.
rating = [0 .. 5]. An integer representing a star rating.
Returns
A bookmark list with one item, the updated bookmark.
Example Response
See bookmarks_get above.
tags_find
http://ma.gnolia.com/api/rest/1/tags_find
Returns the list of tags and the number of associated bookmarks for the person specified.
Parameters
person=[screen_name]
Returns
A response container with a list of tags.
Example Response
<response status="ok" version="1">
<tags>
<tag name="social" count="31"/>
...
</tags>
</response>
