Connected Web - Structure

Definition

A Connected Web Feed File is a JSON or JSONP encoded file which contains a list of contents to be distributed.

This file has the same scope of old RSS or Atom files.

File structure

Optional parameters are indicated as "(Optional)".

Parameter	Meaning	Notes
type (string)	The type of file.	Must be feed
cwversion (float)	The version of the Connected Web format.	It helps a file parser to understand with which version of the Connected Web format should be this file parsed.
name (string)	The name of the feed.	Can be the name of the source or a specific section of it, e.g. My Website > Politics. It's suggested to keep it shorter than 55 characters. If longer, some Connected Web parsers will cut it.
description (string) (optional)	The description of the feed.	This value will help platforms to understand better which kind of contents does this list include. It's suggested to keep it shorter than 160 characters. If longer, some Connected Web parsers will cut it.
keywords (array) (optional)	A list of keywords.	This value will help platforms to understand better which kind of contents does this list include. It's suggested to set no more than 5 tags, otherwise some Connected Web parsers will exclude the remaining ones.
source (string)	The url to a Connected Web Source File.	This parameter requires a link to a Connected Web Source File. See the Structure > Source File documentation to understand more.
contents (array of contents)	The list of contents included in the file.	A content can be an article, a post, an image, a video and so on. It's suggested to include the last 50 contents of the source. This parameter requires a Connected Web Content. See the Content documentation to understand more.
language (string)	The language of the feed.	Must meet ISO 639-1 standardized nomenclature.
cache (cache_object) (optional)	The cache preferences.	This parameter allows to take control of the contents included in the file by specifying how and if platforms are allowed to cache them. This parameter requires a Connected Web Cache Object. See the Objects > Cache documentation to understand more.

Understand Contents

Example


    	{

    "type": "feed",
    "cwversion": 1.1,
    "name": "ConnectedWeb - Showcase",
    "description": "This is an example of a Connected Web Feed.",
    "keywords": "connected, web, feed, example",
    "source": "http://showcase.connectedweb.org/source/",
    "cache": {
    
    	"cacheable": 1,
        "expiresAfter": 60000
    
    },
    "contents": [{
    
    	"title": "This is a simple content",
	"pubTime": 1491255023,
	"body": [{
		
	    "type": "text",
	    "data": {
			
	        "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
			
	    }
		
	}]
    
    }]

}