![[Main Page]](/modules/mediawiki/images/mediawiki.png)
[edit]
Overview
XOOPS provides http://www.xmlrpc.com/ XML-RPC interface, which allows various services and tools to communicate with XOOPS.
XOOPS supports all http://plant.blogger.com/api/index.html Blogger API methods except for setTemplate/getTemplate methods, all http://www.xmlrpc.com/metaWeblogApi metaWeblog API methods, and 1 method from http://www.movabletype.org/docs/mtmanual_programmatic.html#programmatic%20interfaces moveabletype API where applicable. XOOPS also has its own API that can be used to manipulate posts and categories.
Use the following basic host information in your XML-RPC calls
* Host: www.yourhost.com
* Path: /xmlrpc.php
* Port: 80
[edit]
Supported Methods
Following are the XML-RPC methods currently supported by XOOPS:
Note:** The return values below are the values that are returnded on success. All methods will return fault on failure.
[edit]
blogger.newPost**
* Description: Posts a new item. Administrators can optionally publish the post directly.
* Parameters: String appkey, String blogid, String username, String password, String content, Boolean publish
* Returns: String postid of new post
[edit]
blogger.editPost**
* Description: Edits an existing item. Administrators can optionally publish the post directly.
* Parameters: String appkey, String postid, String username, String password, String content, Boolean publish
* Returns: Boolean true
[edit]
blogger.deletePost**
* Description: Deletes an existing item, administrators only.
* Parameters: String appkey, String postid, String username, String password, Boolean publish
* Returns: Boolean true
[edit]
blogger.getPost**
* Description: Retrieves information about a specific item.
* Parameters: String appkey, String postid, String username, String password
* Returns: Struct containing String userId, String content, ISO.8601 dateCreated, String postid
[edit]
blogger.getRecentPosts**
* Description: Retrieves specified number of recently posted items.
* Parameters: String appkey, String blogid, String username, String password, Int numberOfPosts
* Returns: Array of Struct(s) containing ISO.8601 dateCreated, String userid, String postid, String content
[edit]
blogger.getUsersBlogs**
* Description: Returns information about blogs to which a user can post.
* Parameters: String appkey, String username, String password
* Returns: Array of struct(s) containing String url, String blogid, String blogName
[edit]
blogger.getUserInfo**
* Description: Returns information about a user
* Parameters: String appkey, String username, String password
* Returns: Struct containing String userid, String firstname, String lastname, String nickname, String email, String url
[edit]
metaWeblog.newPost**
* Description: Posts a new item. Administrators can optionally publish the post directly.
* Parameters: String blogid, String username, String password, Struct content, Boolean publish
* Returns: String postid of new post
[edit]
metaWeblog.editPost**
* Description: Edits an existing item. Administrators can optionally publish the post directly.
* Parameters: String postid, String username, String password, Struct content, Boolean publish
* Returns: Boolean true
[edit]
metaWeblog.getPost**
* Description: Retrieves information about a specific item.
* Parameters: String postid, String username, String password
* Returns: Struct containing String userid, ISO.8601 dateCreated, String postid, String description, String title, String link, String permaLink
[edit]
metaWeblog.getRecentPosts**
* Description: Retrieves specified number of recently posted items.
* Parameters: String blogid, String username, String password, int numberOfPosts
* Returns: Array of struct(s) containing ISO.8601 dateCreated, String userid, String postid, String description, String title, String link, String permaLink
[edit]
metaWeblog.getCategories**
* Description: Returns information about categories in the blog to which a user can post
* Parameters: String blogid, String username, String password
* Returns: Array of Struct(s) containing String description, String htmlUrl, String rssUrl
[edit]
mt.getCategoryList**
* Description: Returns information about categories in the blog to which a user can post
* Parameters: String blogid, String username, String password
* Returns: Array of Struct(s) containing String categoryId, String categoryName
[edit]
xoops.newPost**
* Description: Posts a new item. Administrators can optionally publish the post directly.
* Parameters: String blogid, String username, String password, Struct content, Boolean publish
* Returns: String postid of new post
[edit]
xoops.editPost**
* Description: Edits an existing item. Administrators can optionally publish the post directly.
* Parameters: String postid, String username, String password, Struct content, Boolean publish
* Returns: Boolean true
[edit]
xoops.deletePost**
* Description: Deletes an existing item, administrators only.
* Parameters: String appkey, String postid, String username, String password, Boolean publish
* Returns: Boolean true
[edit]
xoops.getPost**
* Description: Retrieves information about a specific item.
* Parameters: String postid, String username, String password
* Returns: Struct containing String userid, ISO.8601 dateCreated, String postid, String description, String title, String link, String permaLink
[edit]
xoops.getRecentPosts**
* Description: Retrieves specified number of recently posted items.
* Parameters: String blogid, String username, String password, Int numberOfPosts
* Returns: Array of struct(s) containing ISO.8601 dateCreated, String userid, String postid, String description, String title, String link, String permaLink
[edit]
xoops.getCategories**
* Description: Returns information about categories in the blog to which a user can post
* Parameters: String blogid, String username, String password
* Returns: Array of Struct(s) containing String categoryId, String categoryName, String categoryPid
[edit]
Error Codes
Below is a list of error codes and messages that will be returned with fault response in case of failure.
* 101 - Invalid server URI
* 102 - Parser parse error
* 103 - Module not found
* 104 - User authentication failed
* 105 - Module API not found
* 106 - Method response error
* 107 - Method not supported
* 108 - Invalid parameter
* 109 - Missing parameters
* 110 - Selected blog application does not exist
* 111 - Method permission denied
[edit]
Client Softwares
Below is a list of some recommended XML-RPC client softwares that can be used to communicate with XOOPS
* http://wbloggar.com/ w.bloggar - for Windows only, version 3.0 or higher recommended
Back to the Main Page
