Consuming with Atom and RSS

Atom and RSS are protocols created for distributing blog posts and other syndicated web content. While not a perfect match for the SHARE Notification Service, they do provide a simple way to explore the notifications flowing from the service.

Using the SHARE RSS feed

The SHARE RSS feed can be found at:

https://share-dev.osf.io/api/v1/app/6qajn/rss/

The feed is a layer on top of the existing scrAPI search API developed for SHARE. It takes a query URL parameter, and returns an RSS feed with the results of that query. The query syntax is as follows:

/rss/?q=query_term

You can also specify the field you would like to search, by adding the prefix of field: to the query, like so:

/rss/?q=source:plos

The fields themselves are documented on our metadata schema page

To query the RSS feed, you can use any valid Lucene query syntax. You can query by any field in the metadata schema, by date ranges (using solr date formats), by keywords, or any combination of the above.

Here are some examples of valid queries:

• [/rss/?q=open AND science AND source:scitech](https://share-dev.osf.io/api/v1/app/6qajn/rss/?q=open AND science AND source:scitech)

• /rss/?q=tags:frogs

• [/rss/?q=dateUpdated:[2014-10-01 TO 2014-10-10]](https://share-dev.osf.io/api/v1/app/6qajn/rss/?q=dateUpdated:[2014-10-01T00:00:00Z TO 2014-10-10T00:00:59Z])

Using the SHARE Atom feed

The SHARE Atom feed is nearly identical to the RSS feed. It is available at:

https://share-dev.osf.io/api/v1/app/6qajn/atom/

Atom allows for some greater flexibility in the way the metadata payload is structured. It also allows for some flexibility is specifying the date range of items to be returned. While this flexibility has not yet been leveraged in this Atom feed, we expect to improve it in time. For now, you can treat it much as you would the RSS feed.