Was this page helpful?

GET:pages/{pageid}/tree

    Overview

    public. Builds a site map starting from a given page.

    Uri Parameters
    NameTypeDescription
    pageidstringeither an integer page ID, "home", or "=" followed by a double uri-encoded page title
    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    format{xml, html, google}?Result format (default: xml)
    languagestring?Filter results by language (default: all languages)
    startpagebool?For HTML sitemap, indicates if the start page should be included (default: true)
    Return Codes
    NameValueDescription
    BadRequest400Invalid input parameter or request body
    Forbidden403Browse access to the page is required
    NotFound404Requested page could not be found
    Ok200The request completed successfully

    Message Format

    Output (XML):

    <pages>
        <page id="{int}" href="{uri}">
            <title>{text}</title> 
            <path>{text}</path> 
            <subpages>
                <page>...</page>
                ...
            </subpages>
        </page>
    </pages>

    Output (HTML):

    <ul>
        <li>
            <a rel="internal" href="{uri}" title="{text}" pageid="{int}" class="{text}">{text}</a>
            <ul>
                <li>...</li>
                ...
            </ul>
        </li>
    </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 to retrieve the full sitemap.

    Code Samples

    C# Samples

     

    Curl Samples

     

    PHP Samples

     

    Other Code Samples

     

    Was this page helpful?
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by