Difference between revisions of "XML-RPC Protocol"

Revision as of 03:07, 23 September 2010

Placeholder page. This is where we can link to all of the protocol methods that we have available, including how to use the XML-RPC Protocol, etc...

Using XML-RPC

This would talk about how to use XML-RPC from various languages...

Methods

The protocol is still in flux due to the change from LJ's friends system to Dreamwidth's subscription and access system. Not all of these methods have been pushed live yet, but the code has been committed.

• addcomment
• consolecommand -- Run an administrative command.
• editcircle
• editevent -- Edit or delete a user's past journal entry.
• friendof -- Designed to return a list of which other users list this user as their friend, but currently returns nothing.
• getchallenge -- Generate a server challenge string for authentication.
• getcircle
• getdaycounts -- Retrieve the number of journal entries per day.
• getevents -- Download parts of the user's journal. See also syncitems mode.
• getfriends -- Designed to return a list of which other users this user lists as their friend, but currently returns nothing.
• getfriendspage
• getinbox
• gettrustgroups
• getusertags -- Retrieve a list of the user's defined tags.
• login -- Validate user's password and get base information needed for client to function
• postevent -- Submit a new journal entry to the server.
• sendmessage
• sessionexpire -- Expire session cookies.
• sessiongenerate -- Generate a session cookie.
• setmessageread
• syncitems -- Get a list of all the items that have been created or updated for a user.

Deprecated Methods

• checkfriends -- Checks to see if the user's friends list has been updated since a specified time. Temporarily disabled, to be aliased to new method "checksubscriptions" once that method is written.
• editfriends -- Deprecated, use editcircle instead.
• editfriendgroups -- Deprecated, use editcircle instead.
• getfriendgroups -- Deprecated, use gettrustgroups instead.