Developer manual
/feed
Returns results based on the query attributes
Updated: Type: url
Method
GET /feed/attribute/value/
Current Experimental Deprecated
URL Attributes
| Attribute | Type | Description | Default | Required? | |
|---|---|---|---|---|---|
| current | format | string | The xslt to transform the results with The default is to return the results using the rss.xslt template. |
rss.xslt | No |
| current | source | option | Controls the source of the xml to transform. The default is to query the database for the xml. If 'template' is set, Spring will assume the template specified in the 'format' attribute will contain or call another url for the source xml. Allowed values: database, template |
database | No |
| current | table | option | The source database table to query for xml Allowed values: pages, products, assets |
pages | No |
| current | pages | list | List of pageid's to limit the query to • Separate multiple pageids with a comma • Specify a single pageid to return 1 result |
No | |
| current | category | string | Category to limit the query to | No | |
| current | sort | option | The order to return the results in Allowed values: desc, random, asc, numericid, alpheticalid, mod-asc, mod-desc, listed, position-desc, position, xml-asc:FIELD-ID, xml-desc:FIELD-ID The default order currently is unpredictable - it is recommended you specify a specific order. • asc,desc: Returns the results sorted by publishdate • listed: Requires /pages/<id>,<id>,etc... attribute is set. Returns results in the order listed in the attribute. •position: Returns results based on their position value (the order within the parent folder). It should be noted that results from different folders may have the same sorted value or be incremented differently returning unpredictable results. •xml-asc: Returns the results sorted alphabetically by the value of the xml attribute specified. ie. xml-asc:title sorts by the title field. xml-asc:product:name sorts by the name field contained in the products tag. •xml-desc: Same as xml-asc but in reverse order. |
No | |
| current | limit | number | The maximum number of results to return | 10 | No |
| current | status | number | The status to limit the query to Allowed values: 0, 1, 2, 3, online, hidden, invisible • Status 0 returns all records, Online, Offline, Hidden and Invisible. Requires authenticated editor access. • Status 1 returns all online pages • Status 2 returns all online and hidden pages • Status 3 returns all online, hidden and invisible pages. • Status 'online' returns all online pages • Status 'hidden' returns all hidden pages • Status 'invisible' returns all invisible pages |
1 | No |
| current | published | option | Returns documents with a publishdate within the requested time period Allowed values: thisyear, lastyear, thismonth, lastmonth, thisweek, lastweek, today, yesterday, 12months, 6months, 3months, 2months, 1month, 4weeks, 3weeks, 2weeks, 1week • /published/thisyear would return documents with a publish date of 2013 if the current year is 2013 • /published/12months would return documents with a publish date after October 2012 if the current date is Oct 2013 |
No | |
| current | query | string | Spring query | No | |
| experimental | start | number | The position to start returning results If there are 20 matching records found, and if /limit/10 is set and /start/5/ is set, records 6-15 will be returned |
No | |
| experimental | rawxml | option | Returns the raw xml prior to any xslt transforms Allowed values: 1 This is intended for debugging and development purposes only. It may be unreliable to use in production. |
No | |
| experimental | redirect | string | Spring URL to redirect to after the xslt has been transformed | No | |
| deprecated | cache | option | Caches results server side. Allowed values: 1,2 This is currently under review as Spring now uses a different caching method. |
No | |
| deprecated | page | string | Pageid to limit the query to Use /pages/ instead |
No |
Examples
#1
Request
/feed
Returns RSS feed of 10, online documents, ordered by most recent
Response
<?xml version="1.0"?>
<rss xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xml:lang="en">
... rss feed ...
</rss>
#2
Request
/feed/format/system.news.html.xslt/limit/2
Returns 2, online documents, ordered by most recent, processed by the system.news.html.xslt template
Response
<?xml version="1.0"?>
<result>
<html> ... 1st document ... </html>
<html> ... 2nd document ... </html>
</result>
#3
Request
/feed/format/system.news.html.xslt/pages/about-spring
Returns the 'about-spring' page, processed by the system.news.html.xslt template
Response
<?xml version="1.0"?>
<result>
<html>
<h2>About Spring CMS</h2>
<p>This site is built using Spring CMS, an easy to use web site content management system.</p>
<p>Sites built using the Spring CMS can be edited and updated entirely online from within a standard Internet browser. The interface is easy to use and the web pages created are automatically set-up to be search engine friendly and to validate across multiple browser platforms to meet international standards.</p>
</html>
</result>