Page last modified 00:10, 19 Mar 2009 by MaxM
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
Overview
public. Retrieve feed of page changes
Uri Parameters
| Name | Type | Description |
| pageid | string | either an integer page ID, "home", or "=" followed by a double uri-encoded page title |
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| depth | string? | How deep into the sub-tree changes should be included. 0 for the current page only, 'infinity' for entire sub-tree (default: 0) |
| format | {all, daily, raw, rawdaily}? | Format for feed (default: daily) |
| limit | int? | Number of changes to retrieve (default: 100) |
| offset | int? | Skipped changes (default: 0) |
| redirects | int? | If zero, do not follow page redirects. |
| since | string? | Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored). |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Read/suscribe access to the page is required |
| NotFound | 404 | Requested page could not be found |
| Ok | 200 | The request completed successfully |
Message Format
Output (Atom): Refer to http://www.w3.org/2005/Atom
Output (Digest/Raw):
<digest>
<change>
<rc_id>{int}</rc_id>
<rc_comment>{text}</rc_comment>
<rc_cur_id>{int}</rc_cur_id>
<rc_last_oldid>{int}</rc_last_oldid>
<rc_namespace>{int}</rc_namespace>
<rc_timestamp>{date}</rc_timestamp>
<rc_title>{text}</rc_title>
<rc_type>{int}</rc_type>
<rc_moved_to_ns>{int}</rc_moved_to_ns>
<rc_moved_to_title>{text}</rc_moved_to_title>
<rc_user_name>{text}</rc_user_name>
<rc_watched>{int}</rc_watched>
<rc_page_exists>{int}</rc_page_exists>
<edit_count>{int}</edit_count>
</change>
...
</digest>
Implementation Notes
Atom and Digest formats retrieve a compressed summary of page changes, whereas the Raw format lists each change individually.
Code Samples
The following code example retrieves the feed for the page called "Page_Title":
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("pages", "=Page_Title", "feed").Get();
Sample response feed indicating that the page was edited four times:
<feed xmlns="http://www.w3.org/2005/Atom" version="1.0" xml:lang="en-us">
<generator version="1.3.99.4871">MindTouch Dream XAtom</generator>
<updated>2007-08-29T20:12:49Z</updated>
<title type="text">Page Changes - Page Title</title>
<link rel="self" href="http://deki-hayes/@api/deki/pages/=page_title/feed?format=atom" />
<id>http://deki-hayes/@api/deki/pages/=page_title/feed?format=atom</id>
<entry>
<title type="text">Page Title</title>
<published>2007-08-29T19:14:29Z</published>
<updated>2007-08-29T19:14:29Z</updated>
<id>http://deki-hayes/Page_Title</id>
<author>
<name>Admin</name>
</author>
<link href="http://deki-hayes/Page_Title" rel="alternate" />
<summary type="xhtml">
<div xmlns="http://www.w3.org/1999/xhtml">
<p>Edited 4 times by Admin (added 'myfile.jpg')</p>
<p>
<strong>2 words added, 1 words removed</strong>
</p>
<hr width="100%" size="2" />
<p>
<ins style="color: #009900;background-color: #ccffcc;text-decoration: none;">new</ins>
<del style="color: #990000;background-color: #ffcccc;text-decoration: none;">original</del>
text
<ins style="color: #009900;background-color: #ccffcc;text-decoration: none;">2</ins>
</p>
</div>
</summary>
</entry>
</feed>
- Tag page
- What links here
Images 0
You must login to post a comment.