API REFERENCE GUIDE

cloud content content_rss

api description

purpose

content_rss returns a RSS stream which is built with the list of archived and current versions of text content edited in AuverCloud Studio.

The result can be returned either as a standard JSON response or directly as a XLM stream. See the optional parameter output below.

http method: GET

call cost: 1 point

See the pricing section for more details.

mandatory parameter(s)

parameter values / comments
api"content_rss"
key E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio.
cnameText content name as defined in AuverCloud Studio e.g. "hello_world"

optional parameters(s)

PLEASE NOTE: Some of the following parameters require URL encoding in order to be used in GET requests. Consider PHP rawurlencode or JavaScript encodeURIComponent to do so.

parameter values / comments
outputThis parameter defines the response output format. The value should be either json or xml (default value).
titleURL_encoded RSS title. Default value: .
descriptionURL_encoded RSS description. Default value: .
urlAny URL_encoded relevant URL, usually it is the address of the HMTL page that is equivalent to the RSS stream. Default value: .
language RSS language. See RSS advisory board for usual values. Default value: en.
maxMaximum number of RSS items to display. Default value: 10.

call sample

To get directly the RSS content, the call should look like this example based on the AuverCloud blog:

Anoter example, as used in the test case below, returns a string which contains the XML content. It assumes that jQuery and the JavaScript AuverCloud runtime client are loaded in order to use the arc.api() method. See the API client section for more details.


							

errors

code message comments
640 Unknown content. This occurs when the combination of content name, type and date does not exist in the account related to the application key.

See also the Common errors section.

test bed

Call

To test the API with your own keys, please see the section Application keys in AuverCloud Studio.

api
content_rss
key
cname
output
json
title
description
url
language
max
 send
request
 clear
response
Response
code
msg
data

discussion