pages (GET)

Overview

Builds a site map starting from 'home' page.

REST Method: GET
Method Access: public

Query Parameters

Name	Type	Description
startpage	bool?	For HTML sitemap, indicates if the start page should be included (default: true)
format	{xml, html, google}?	Result format (default: xml)
authenticate	bool?	Force authentication for request (default: false)

Return Codes

Name	Value	Description
OK	200	The request completed successfully
Bad Request	400	Invalid input parameter or request body
Forbidden	403	Browse access to the page is required
Not Found	404	Requested page could not be found

Message Format

Output (XML):

01<pages>
02    <page id="{int}" href="{uri}">
03        <title>{text}</title> 
04        <path>{text}</path> 
05        <subpages>
06            <page>...</page>
07            ...
08        </subpages>
09    </page>
10</pages>

Output (HTML):

1<ul>
2    <li>
3        <a rel="internal" href="{uri}" title="{text}" pageid="{int}" class="{text}">{text}</a>
4        <ul>
5            <li>...</li>
6            ...
7        </ul>
8    </li>
9</ul>

Output (sitemap): Refer to http://www.google.com/schemas/sitemap/0.84

Implementation Notes

Redirect and archived pages are not included in the sitemap.

Use GET:pages/{pageid}/tree to retrieve the sitemap from a specified page.

C# Code Sample: Retrieve Sitemap

The following code example retrieves the sitemap in XML format:

Sample Code

1Plug p = Plug.New("http://deki-hayes/@api/deki");
2p.At("users", "authenticate").WithCredentials("admin", "password").Get();
3p.At("pages").With("format", "xml").Get();

Sample response indicating that the home page has one sub-page called "Page Title". This sub-page has one sub-page called "Subpage 1":

Sample Response from executing Code

01<pages>
02    <page id="29" href="http://deki-hayes/@api/deki/pages/29">
03        <title>DekiWiki (Hayes)</title> 
04        <path /> 
05        <subpages>
06            <page id="31" href="http://deki-hayes/@api/deki/pages/31">
07                <title>Page Title</title> 
08                <path>Page_Title</path> 
09                <subpages>
10                    <page id="32" href="http://deki-hayes/@api/deki/pages/32">
11                        <title>Subpage 1</title> 
12                        <path>Page_Title/Subpage_1</path> 
13                        <subpages /> 
14                    </page>
15                </subpages>
16            </page>
17        </subpages>
18    </page>
19</pages>

Implementation notes

Add notes about requirements or config values

Curl Code Sample: Retrieve Sitemap

The following command retrieves a hierarchical representation of the site's pages:

Sample Code

`1`	`curl -u username:password -i http://mindtouch.address/@api/deki/pages`

Sample Response from executing Code

01<pages>
02  <page id="21" href="http://192.168.59.128/@api/deki/pages/21?redirects=0"> <!-- homepage -->
03    <uri.ui>http://192.168.59.128/</uri.ui>
04    <title>Best Wiki Ever</title>
05    <path/>
06    <namespace>main</namespace>
07    <subpages>
08      <page id="565" href="http://192.168.59.128/@api/deki/pages/565?redirects=0">
09        <uri.ui>http://192.168.59.128/Bar</uri.ui>
10        <title>Bar</title>
11        <path>Bar</path>
12        <namespace>main</namespace>
13        <subpages/>
14      </page>
15      <page id="567" href="http://192.168.59.128/@api/deki/pages/567?redirects=0">
16      ...
17      </page>
18    ...
19    </subpages>
20    ...
21  </page>
22</pages>

Implementation notes

curl flags

-u: Provides external user authentication. Note that if anonymous access is available and authentication is not forced, this flag may be omitted.
-i: Outputs the HTTP response headers. Useful for debugging.