Ambra Article and Annotation Feeds
Feed URL Action
http://journal.example.org/article/feed
Description
Ambra provides Article and Annotation information through an Atom 1.0 feed. Various parameters can be passed to the feed action to limit the information returned to articles and particular types of annotations. Articles and annotations can also be returned based on meta-data parameters such as publication dates, authors and categories. A list of parameters and their values can be found at the end of this article.
Article Feed
The default feed behavior is to return information on articles (type=Article). The maximum number of articles that can be returned is 200 (maxResults=200). If no parameters are specified to the feed action then information pertaining to 30 of the latest articles in the current journal will be returned. A publication date range can be specified by supplying dates for startDate and endDate. The dates must be in ISO yyyy-MM-dd format.
Annotation Feed
(type=Annotation, FormalCorrectionAnnot?,
MinorCorrectionAnnot?, CommentAnnot?)
Parameters
| Parameter | Format | Required | Default | Description |
| author | String | No | None | Article author name (no wildcards or partial names). eg. John+Smith |
| category | String | No | None | Article category (no wildcards or partial categories). eg. Cell+Biology |
| endDate | ISO yyyy-MM-dd | No | None | Search for articles with dates less than or equal to endDate. |
| extended | Boolean | No | false | Extended article information is added to the feed results. |
| startDate | ISO yyyy-MM-dd | No | None | Search for articles with dates greater than or equal to startDate. |
| maxResults | Integer | No | 30 | Maximum number of articles/Annotations to return in this feed query. |
| relLinks | Boolean | No | False | Sets internal link relative to xmlBase. |
| selfLink | URL | No | None | Sets the URL of the feed source that is included in the feed data. |
| title | String | No | None | Sets the title of the feed. |
| type | String | No | Article | Sets the type of information to be returned from the feed. The following are valid type parameters: Article, Annotation, FormalCorrectionAnnot?, MinorCorrectionAnnot?, CommentAnnot? |
