Service List

Syndic8 Home Page
Go to Feed ID:   
 » Log In  » Register  » Suggest  » Feeds  » News  » Podcasts  » Tags  » Pings  » Documents  » XML  » Web Services  » Categories  » Statistics  » Help  » Site Map  » About 

Basic Functions / Personal List Functions / Suggest Return Values / Error Return Values

The following XML-RPC web service calls can be used to access and change information within the Syndic8 site.

The XML-RPC endpoint is http://www.syndic8.com/xmlrpc.php.

Function NameArgumentsReturnsDetails
syndic8.FindFeeds
  • string Pattern to match against all feed field
  • (optional) string Field to sort results
  • (optional) int Result Limit
  • (optional) int Result Start
 Array of FeedIDs of matching feeds This function takes the given pattern, matches it against all of the text fields of each feed in the feed list, optionally sorts, the results by the given field, and returns the FeedIDs of the matching feeds, optionally restricted to the given limit, optionally from the given 0-based starting point.
syndic8.FindSites
  • string Pattern to match against SiteURL field
 Array of FeedIDs of matching feeds This function takes the given pattern, matches it against the SiteURL feed of each feed in the feed list, and returns the FeedIDs of the matching feeds.
syndic8.FindUsers
  • string Pattern to match against user fields
 Array of UserIDs of matching users This function takes the given pattern, matches it against all text fields of the user list, and returns the UserIDs of the matching users.
syndic8.GetAllFeedTags Array of tags This function returns all of the tags assigned to feeds, across all feeds and all users.
syndic8.GetAllFeedTags
  • string UserID of a user
  • string Password (MD5 or cleartext)
 Array of tags This function returns all of the tags assigned to feeds, across all feeds, by the given user.
syndic8.GetCategoryChildren
  • string Category Scheme
  • string Category
 Array of category names This function returns the immediate child categories of the given category.
syndic8.GetCategoryRoots
  • string Category Scheme
 Array of category names This function returns the top-level category names for the given scheme.
syndic8.GetCategorySchemes Array of category schemes This function returns an array of the supported category schemes
syndic8.GetCategoryTree
  • string Category Scheme
 Array of category names This function returns the set of known categories for the given category scheme.
syndic8.GetChangedFeeds
  • array of string Fields to Check
  • string StartDate (YYYY-MM-DD)
  • string EndDate (YYYY-MM-DD)
  • array of string Fields to Return
 Array of structures, each containing the requested fields from feeds with changes in the given date range. This function accepts an array of fields to check and a date range for checking, along with a list of fields to return. It checks the change log for the feeds, and returns the requested feed fields for each feed where a requested field has changed.
syndic8.GetFeedCount Number of feeds This function returns the number of feeds that are in the Syndic8 feed table.
syndic8.GetFeedFields Array of feed field names This function returns an array of the valid field names for a feed.
syndic8.GetFeedInfo (array)
  • array of int FeedID or string DataURL of a feed, possibly returned from FindFeeds
  • (optional) array of string field names
 Array of structures containing all feed fields (or requested fields only) from database, plus faultCode and faultMessage. This function accepts an array of FeedIDs or DataURLs of Syndic8 feed and returns an array of structures containing the requested information from the feeds table for each feed. Field names and interpretations are subject to change.
syndic8.GetFeedInfo (scalar)
  • FeedID or string DataURL of a feed, possibly returned from FindFeeds
  • (optional) array of string field names
 Structure containing all feed fields (or requested fields only) from database This function accepts the FeedID or DataURL of a known Syndic8 feed and returns a structure containing the requested information from the feeds table. Field names and interpretations are subject to change.
syndic8.GetFeedsInCategory
  • string Category Scheme
  • string Category
  • (optional) boolean WithChildren
 Array of FeedIDs of feeds in category This function returns the list of feeds in the given category (and optionally in child categories) within the given scheme.
syndic8.GetFeedStates Array of structures, each a feed state and its description. This function returns the list of valid feed states.
syndic8.GetLastFeed Highest assigned FeedID. This function returns the highest assigned FeedID.
syndic8.GetLicenses Array of structures This function returns an array of structures. Each structure represents a single type of feed license.
syndic8.GetLocationSchemes Array of location schemes This function returns an array of the supported location schemes.
syndic8.GetTaggedFeeds
  • string Tag
 Array of FeedIDs of all feeds with the given tag. This function returns the Feed IDs of all feeds that have the given tag, across all users.
syndic8.GetTaggedFeeds
  • string UserID of a user
  • string Password (MD5 or cleartext)
  • string Tag
 Array of FeedIDs of all feeds with the given tag. This function returns the Feed IDs of all feeds that have the given tag, for the given user.
syndic8.GetToolkits Array of structures, each a toolkit ID and toolkit name This function returns the list of toolkits known to Syndic8.
syndic8.GetUserInfo
  • string UserID of a user, possibly returned from FindUsers
 Structure containing all user fields from database (except password!) This function accepts the UserID of a known Syndic8 user and returns a structure containing all of the information from the users table. Field names and interpretations are subject to change.
syndic8.QueryFeeds
  • string Feed field to match
  • string Relational operator
  • string Value to match
  • (optional) string Field to sort results
  • (optional) int Result Limit
  • (optional) int Result Start
 Array of FeedIDs of matching feeds This function takes the given feed field, relationship (<, >, <=. >=, !=, =, like, or regexp), and feed value and returns the list of feeds with a matching value in the field, optionally sorted by the given sort field, optionally restricted to the given limit, optionally from the given 0-based starting point.
syndic8.SetFeedCategory
  • string UserID
  • string Password (MD5 or cleartext)
  • int FeedID
  • string Category Scheme
  • string Category Value
 Status code This function sets the feed's category within the given scheme as specified. A valid UserID and Password must be supplied, and the User must have the Categorizer role.
syndic8.SetFeedLocation
  • string UserID
  • string Password (MD5 or cleartext)
  • FeedID
  • string Location Scheme
  • string Location Value.
 Status code This function sets the feed's location within the given scheme as specified. A valid UserID and Password must be supplied, and the User must have the Categorizer role.
syndic8.SetUserLocation
  • string UserID
  • string Password (MD5 or cleartext)
  • string TargetUserID
  • string Location
 1 on success, 0 on failure This function sets the Location field of TargetUserID to the given value. The caller (as identified by UserID) must have the Editor role.
syndic8.SuggestDataURL
  • string DataURL of suggested feed
  • string UserID of user making suggestion
 Structure with Status code (see below) and FeedID This function checks to see if DataURL is that of a known feed. If it is not, the feed is entered as a new feed. In either case, a FeedID is returned.
syndic8.SuggestSiteURL
  • string SiteURL of suggested feed
  • string UserID of user making suggestion
 Structure with Status code (see below) and FeedID This function checks to see if SiteURL is that of a known feed. If it is not, the feed is entered as a new feed. In either case, a FeedID is returned.
syndic8.TagFeed
  • string UserID of a user
  • string Password (MD5 or cleartext)
  • int FeedID
  • string Tag
 Status code This function tags the given feed with the given tag.
weblogUpdates.extendedPing
  • string SiteName
  • string SiteURL
  • string Unknown
  • string DataURL
 Status message This function accepts notification of a change at the given feed as specified by the DataURL.
weblogUpdates.Ping
  • string SiteName
  • string SiteURL
 Status message This function accepts notification of a change at the given site.

Basic Functions / Personal List Functions / Suggest Return Values / Error Return Values

The following calls are applicable only to users with the PersonalList option

Function NameArgumentsReturnsDetails
syndic8.CreateSubscriptionList
  • string UserID
  • string Password (MD5 or cleartext)
  • string List Name
  • bool Public
 This function creates a new subscription list for the given user, and returns the List identifier of the list.
syndic8.CreateSubscriptionListFromHTML
  • string UserID
  • string Password (MD5 or cleartext)
  • string List Name
  • bool Public
  • string HTML URL
  • boolean AutoSuggest
 This function creates a new subscription list for the given user. The list will contain feeds referenced from the given HTML page. If AutoSuggest is given, unknown feeds will be automatically suggested as new feeds.
syndic8.CreateSubscriptionListFromOPML
  • string UserID
  • string Password (MD5 or cleartext)
  • string List Name
  • bool Public
  • string OPML URL
  • boolean AutoSuggest
 This function creates a new subscription list for the given user. The list will contain the feeds from the given OPML. If AutoSuggest is given, unknown feeds will be automatically suggested as new feeds.
syndic8.CreateUser
  • string SponsorID
  • string SponsorPassword
  • string UserID
  • string FirstName
  • string LastName
  • string Email
  • string Password
  • string Roles
  • string Options
  • bool EmailSiteInfo
  • string HomePage
  • string StyleSheet
  • string VCard
 This function creates a new Syndic8 user. The caller (sponsor) must have the CreateUser option set in order for this call to proceed.
syndic8.DeleteSubscriptionList
  • string UserID
  • string Password (MD5 or cleartext)
  • int List
 This function deletes the indicated subscription list. All feeds and categories will be removed from the list.
syndic8.GetSubscribed
  • string UserID
  • string Password (MD5 or cleartext)
  • int List
  • (optional) array of string field names
 This function returns the set of feeds that the user is subscribed to both directly (as feeds) and indirectly (via a category of feeds).
syndic8.GetSubscribedCategories
  • string UserID
  • string Password (MD5 or cleartext)
  • int List
 This function returns the set of categories that the user is subscribed to, as an array of structures containing schemes and categories.
syndic8.GetSubscribedFeeds
  • string UserID
  • string Password (MD5 or cleartext)
  • int List
  • (optional) array of string field names
 This function returns the set of feeds that the user is directly subscribed to.
syndic8.GetSubscriptionLists
  • string UserID
  • string Password (MD5 or cleartext)
 This function returns the list of subscription lists for the given user. Each structure includes the list id, name, and status (public or private).
syndic8.SetSubscriptionListInfo
  • string UserID
  • string Password (MD5 or cleartext)
  • int List
  • struct New Values
 This function changes values stored for a list. The structure argument must contain new values for the items (name, public, etc.)
syndic8.SubscribeCategory
  • stringUserID
  • stringPassword (MD5 or cleartext)
  • string Category Scheme
  • string Category
  • int List
 This function subscribes the user's given list (0 is the public list) to the given category of feeds. The user must have the PersonalList option.
syndic8.SubscribeFeed
  • string UserID
  • string Password (MD5 or cleartext)
  • int FeedID or string DataURL
  • int List
  • bool AutoSuggest
 This function subscribes the user's given list (0 is the public list) to the given feed. The user must have the PersonalList option. If a DataURL is given and AutoSuggest is true and the feed is not known, it will be suggested as if by entered by UserID.
syndic8.UnSubscribeCategory
  • string UserID
  • string Password (MD5 or cleartext)
  • string Scheme
  • string Category
  • int List
 This function unsubscribes the user from the given category of feeds within the list.
syndic8.UnSubscribeFeed
  • string UserID
  • string Password (MD5 or cleartext)
  • int FeedID
  • int List
 This function unsubscribes the user from the given feed within the list.

Basic Functions / Personal List Functions / Suggest Return Values / Error Return Values

The Suggest functions will return one of the following values in the Result field of the structure:

Value Name Meaning
1 suggestALREADY_QUEUED The DataURL is already known, and the site is currently being polled to prepare it for review.
2 suggestALREADY_EVANGELIZING The SiteURL is already known, and the site is currently being evangelized.
3 suggestALREADY_KNOWN The DataURL or SiteURL is already known and the status is neither queued nor evangelizing.
4 suggestACCEPTED The DataURL or SiteURL was not known. It has been accepted for reviewing or evangelization, as appropriate.
5 suggestERROR Something went wrong.
6 suggestNO_PREFIX The URL did not have an 'http://' prefix.
7 suggestNO_FETCH The information referred to by the URL could not be fetched.
8 suggestNOT_FEED The information referred to by the URL did not appear to be a valid feed.
9 suggestNUMERIC_IP The URL contained a numeric IP address.
10 suggestBLOCKED The URL is from a domain or sub-domain that is not currently accepted into Syndic8.
12 suggestNOT_SITE The URL is for a feed, not for a site. Pass it to SuggestDataURL, not SuggestSiteURL.
13 suggestNO_SITE The feed's Site URL does not point to an accessible web site.
14 suggestUNKNOWN_FORMAT The feed is not in a known syndication format.
15 suggestNO_PARSE The feed could not be parsed.

Basic Functions / Personal List Functions / Suggest Return Values Error Return Values

The functions described above will return one of the following error codes if something goes wrong.

Value Name Meaning
801 errorQUERY_FAILED A select query failed due to a database problem.
802 errorNO_FEED The FeedID supplied to the call is not valid.
803 errorNO_USER The UserID supplied to the call is not valid.
804 errorINVALID_USER The user name or password is not valid.
805 errorNO_SCHEME The categorization or location scheme is invalid.
807 errorNO_SET_CATEGORY The category could not be set.
808 errorMUST_BE_CATEGORIZER The function requires that the user have the Categorizer role.
809 errorNO_SET_LOCATION The location could not be set.
810 errorNO_RETRIEVE_BY_CATEGORY The feeds could not be retrieved for the category.
811 errorNO_SUBSCRIBE_FEED The subscription request for the feed could not be completed.
812 errorNO_SUBSCRIBE_CATEGORY The subscription request for the category could not be completed.
813 errorMUST_HAVE_PERSONAL_LIST The user must have the PersonalList option set to perform the operation.
814 errorSUGGEST_FAILURE Auto-suggesting the DataURL failed.
815 errorNO_DATA_URL The non-numeric FeedID/DataURL given to SubscribeFeed did not appear to be a URL.
816 errorNO_UNSUBSCRIBE_FEED The unsubscription request for the feed could not be completed.
817 errorNO_UNSUBSCRIBE_CATEGORY The unsubscription request for the category could not be completed.
818 errorNO_DELETE_LIST The subscription list could not be deleted.
819 errorDUPLICATE_USERID The given UserID is already in use.
820 errorDUPLICATE_EMAIL The given Email is already in use.
821 errorINVALID_SPONSOR The SponsorID or SponsorPassword is not valid.
822 errorMUST_HAVE_CREATE_USER The sponsor must have the CreateUser option set to perform the operation.
823 errorBAD_QUERY The query given to QueryFeeds is defective.
824 errorNO_FIELD An invalid field name was given to GetFeedInfo.
825 errorNO_LIST An invalid list identifier was given.
826 errorNO_CREATE_LIST The subscription list could not be created.
827 errorMUST_BE_EDITOR The caller must have the Editor role.
828 errorBAD_USERID The supplied User ID is syntactically invalid.
829 errorNO_SET_REFERENCE Could not set the reference Feed ID.
830 errorARRAY_SCALAR_MISMATCH All arguments must be arrays, or all must be scalars.
831 errorARRAY_SIZE All array arguments must be of the same size.
832 errorNO_TOOLKITS Toolkit data could not be retrieved.
833 errorNO_LICENSES License data could not be retrieved.
834 errorNO_FETCH_OPML The OPML could not be fetched.
835 errorNO_PARSE_OPML The OPML could not be parsed.
835 errorDUPLICATE_OUTLINEID The OPML contains more than one outline with the same id.
 
Syndic8.com - Copyright © 2001-2013 Jeff Barr & Bill Kearney - All Rights Reserved