GET:pages/{pageid}/files,subpages

Overview

public. Retrieves a list of files and subpages for a given page

Message Format

Output:

<page id="{int}" href="{uri}">
    <title>{text}</title> 
    <path>{text}</path> 
    <subpages href="{uri}">
        <page.subpage id="{int}" href="{uri}">
            <title>{text}</title> 
            <path>{text}</path> 
        </page.subpage>
        ... 
    </subpages>
    <files count="{int}">
        <file id="{int}" href="{uri}">
            <filename>{text}</filename> 
            <description>{text}</description> 
            <contents type="mimetype" size="{int}" width="{int}" height="{int}" href="{uri}" /> 
            <contents.preview rel="thumb" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" /> 
            <contents.preview rel="webview" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" /> 
            <date.created>{date}</date.created> 
            <user.createdby id="{int}" href="{uri}">
                <nick>{text}</nick> 
                <username>{text}</username> 
                <email>{text}</email> 
            </user.createdby>
            <revisions count="{int}" href="{uri}" /> 
        </file>
        ...
    </files>
</page>

Implementation Notes

The contents.preview element only exists if a file preview is available. Preview generation requires the file to be an image and fall within a certain size.

Files and pages in the archive are not included in the output.

Code Samples

The following code example retrieves the files and 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", "files,subpages").Get();

Sample response indicating that there is one file and one subpage:

<page id="29" href="http://deki-hayes/@api/deki/pages/29">
    <title>DekiWiki (Hayes)</title> 
    <path /> 
    <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>
    <files count="1">
        <file id="456" href="http://deki-hayes/@api/deki/files/456/info">
            <filename>myfile.jpg</filename> 
            <description /> 
            <contents type="image/pjpeg" size="53112" width="476" height="480" href="http://deki-hayes/@api/deki/files/456" /> 
            <contents.preview rel="thumb" type="image/pjpeg" maxwidth="160" maxheight="160" href="http://deki-hayes/@api/deki/files/456?size=thumb" /> 
            <contents.preview rel="webview" type="image/pjpeg" maxwidth="550" maxheight="550" href="http://deki-hayes/@api/deki/files/456?size=webview" /> 
            <date.created>2007-08-29T20:44:00Z</date.created> 
            <user.createdby id="1" href="http://deki-hayes/@api/deki/users/1">
                <nick>Admin</nick> 
                <username>Admin</username> 
                <email>admin@mindtouch.com</email> 
            </user.createdby>
            <revisions count="2" href="http://deki-hayes/@api/deki/files/456/revisions" /> 
        </file>
    </files>
</page>