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 list of page aliases
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) |
| redirects | int? | If zero, do not follow page redirects. |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Read access to the page is required |
| NotFound | 404 | Requested page could not be found |
| Ok | 200 | The request completed successfully |
Message Format
Output:
<aliases count="{int}" href="{uri}">
<page id="{int}" href="{uri}">
<title>{text}</title>
<path>{text}</path>
</page>
...
</aliases>
Implementation Notes
An alias is a page that redirects to a given page. The system automatically creates an alias when a page is moved or renamed.
Code Samples
The following code example retrieves the aliases for the page "Page Title":
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
DreamMessage msg = p.At("pages", "=Page_Title", "aliases").Get();
Sample response indicating that the page "Page Title 1" is an alias to "Page Title":
<aliases count="1" href="http://deki-hayes/@api/deki/pages/202/aliases">
<page id="207" href="http://deki-hayes/@api/deki/pages/207">
<title>Page Title 1</title>
<path>Page_Title_1</path>
</page>
</aliases>
- Tag page
- What links here
Images 0
You must login to post a comment.