XMLRPC API

Stefan V. — Tue, 06 Jul 2010 14:03:22 +0000

thanks, the getSpaces() was exactly what I was looking for!

XMLRPC API

Dhiraj Gupta — Tue, 06 Jul 2010 14:03:22 +0000

    def getSiteTitle(self):
        """Return the site title"""
    def getRecentUpdates(self,maxitemcount=5,pagenumber=1):
        """Return the recent updates"""
    def refreshUpdateItem(self,uid):
        """Resends a single item of the same structure as the one in getRecentUpdates with the most updated info"""
    def getTypeInfo(self,typename):
        """Returns the type title and icon url for given typename"""
    def getUserInfo(self,userid):
        """Return the user name details, and avatar url for given userid"""
    def getWikiBody(self,uid):
        """Return the wiki body text, pre-cooked and processed"""
    def getEventInfo(self,uid):
        """Return the information available for a Calendar Event"""
    def getFileInfo(self,uid):
        """Return the info available for a file"""
    def getLinkInfo(self,uid):
        """Return the info available for a link"""
    def getBlogEntry(self,uid):
        """Return the info available for a Blog Entry"""
    def getComments(self,uid):
        """Return all the comments for the given object's UID"""
    def addNewComment(self,uid,subject,text,commenter):
        """Adds a comment on the provided UID with given subject, text and commenter user"""
    def replyToComment(self,uid,subject,text,commenter):
        """Replies to the given comment's UID with given subject, text and commenter user"""
    def getUpdateCount(self):
        """Returns number of recent items available for recent user"""
    def search(self,searchableText,maxitemcount=5,pagenumber=1):
        """Returns result for search text entered for recent user"""
    def searchIds(self,searchableText='',maxitemcount=5,pagenumber=1):
        """Returns search results with only id, lastchangedate and relevance for search text entered."""
    def getStatusMessages(self,username='',count=1,pagenumber=1):
        """Returns current status message for passed username. For empty username method returns status message for current user"""
    def getStatusMessage(self,username=''):
        """Returns current status message of passed user as string"""
    def setStatusMessage(self,message):
        """Set status log message for current user"""
    def getLastChangeDate(self):
        """Returns the max lastchangedate for the logged in user."""
    def getRecentItemIds(self,maxitemcount=5,pagenumber=1):
        """Return the recent UIDs, up to a maximum of maxitemcount items will be returned in a list"""
    def getSearchItemsByIds(self,arrUIDs):
        """Return the search items as per the UIDs requested."""
    def getItemsByIds(self,maxitemcount=5,pagenumber=1):
        """Return the Update items as per the UIDs requested."""
    def getUsersByIds(self,arrUserIds):
        """Return the user info objects for the users specified"""
    def getTypesByNames(self,arrTypeNames):
        """Return the type info objects for the type names specified"""

Python Example

Create a script called 'sitetitle.py'

import xmlrpclib
username = "yourname"
password = "yourpassword"
siteurl = "http://www.cynapse.com/community" # change this to match your cyn.in portal
proxy = xmlrpclib.ServerProxy("http://%s:%s@%s/stacker" % (username,password,siteurl))
print proxy.getSiteTitle()

The expected output will look like this:

python sitetitle.py

similar code could easily be added to any python framework to support interaction with your cyn.in portal

PHP Example

To do this with PHP, look here: Getting new items via PHP and XMLRPC

Dhiraj Gupta — Tue, 06 Jul 2010 07:28:56 +0000

The full, updated list of functions is always available from the interfaces.py file in the ubify.xmlrpc product. Similarly stacker.py has definition for most of the methods in the interfaces.py contract.

ODN view (cynapse.com login required): http://odn.cynapse.com/[…]/interfaces.py

Adding new methods to the API is not difficult; is there a particular function that you need? If you're looking to get a list of Spaces that are available, look at using the getSpaces() call; this will return a nested struct of Spaces that are visible to the user you're using to call the method.

Stefan V. — Mon, 05 Jul 2010 12:26:18 +0000

Are there more methods? For example to get the Searchfolders or the Areas? Or is this the full list?

Guido Kopkow — Wed, 23 Jun 2010 06:43:20 +0000

Java will have some issues handling utf-8. We will try to solve. Just wondering about HTML codes in message text which are different to title text. The HTML codes are shown in desktop client header text in detail view, which I have already reported in bug tracker.

Dhiraj Gupta — Tue, 22 Jun 2010 19:32:22 +0000

Yes, output should be utf-8 encoded. What's going wrong?

Guido Kopkow — Tue, 22 Jun 2010 18:09:16 +0000

Using getRecentUpdates method, the message text contains special characters which are HTML coded. The title text contains different coded character. Which format is it? utf-8?

Stefan V. — Mon, 21 Jun 2010 11:42:51 +0000

I changed the parameters and now it works fine. thank you for your suggestion.

Dhiraj Gupta — Mon, 21 Jun 2010 10:44:59 +0000

Hmm.... Are you sending any parameters to getRecentUpdates() call? This looks like an argument parsing / sending exception? Does it say something more specific on the Cyn.in Server side in an exception trace in the instance log?

How to see this log? Either run your test Cyn.in instance in "fg" mode (with ./bin/instance fg command) or do a tail -f on both the log files in <buildout home>/var/logs folder if you're testing with your testing with your live production.

Stefan V. — Mon, 21 Jun 2010 10:12:10 +0000

I try to implement a JavaClient for Cynapse. I already got an array of Strings (getTypeInfo) without any problems. Now I tried to call the method "getRecentUpdates" and receive the message "Unexpected Zope exception: exceptions.TypeError - can't multiply sequence by non-int". Any ideas, how to solve the problem?

Guido Kopkow — Wed, 16 Jun 2010 21:30:28 +0000

Yes, we will post Java code as soon as testing is finished. THX for your remarks.

Dhiraj Gupta — Wed, 16 Jun 2010 10:43:26 +0000

Hmm... good point, the interface contract does not define the return structure. Consider going through the python code of the particular API methods you want to hook up. Typically the implementation will be found in stacker.py and from this you can figure out what the return might be.
Note: Sometimes the return can vary in error conditions, so I'm not really sure that endpoint marshalling/stub code might be up to the task, in Java. Remember to study the particular method codes to analyze if an error will return something or throw an XML-RPC fault. In case of fault the result should be handle-able, in Java.

Consider putting down a simplified example for your Java end-point for discussion and usage by the community as well, just like the PHP one. :)

Guido Kopkow — Tue, 15 Jun 2010 19:24:25 +0000

Is there also a description of return data structure available? We are using Java as client, which requires data type description of returned values.

Guido Kopkow — Fri, 04 Jun 2010 06:51:56 +0000

Many THX!

Dhiraj Gupta — Thu, 03 Jun 2010 10:44:13 +0000

Here: http://odn.cynapse.com/[…]/interfaces.py

Alternatively, use this URL for a syntax highlighted view (requires cynapse.com login):
http://odn.cynapse.com/[…]/interfaces.py