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 sub-pages
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:
<subpages href="{uri}">
<page.subpage id="{int}" href="{uri}">
<title>{text}</title>
<path>{text}</path>
</page.subpage>
...
</subpages>
Implementation Notes
Redirect and archived pages are not included in the output.
Code Samples
The following code example retrieves the subpages for the home page:
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("pages", "home", "subpages").Get();
Sample response indicating that there is one subpage:
<subpages href="http://deki-hayes/@api/deki/pages/29/subpages">
<page.subpage id="31" href="http://deki-hayes/@api/deki/pages/31">
<title>Page Title</title>
<path>Page_Title</path>
</page.subpage>
</subpages>
- Tag page
- What links here
uri.ui
namespace