Was this page helpful?

GET:site/tags/{tagid}

    Overview

    public. Retrieve pages with tag

    Uri Parameters
    NameTypeDescription
    tagidstringeither an integer tag ID or "=" followed by a double uri-encoded tag name
    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    languagestring?filter pages by language (default: all languages)
    Return Codes
    NameValueDescription
    BadRequest400Invalid input parameter or request body
    Forbidden403Read access to the page is required
    NotFound404The requested page could not be found
    Ok200The request completed successfully

    Message Format

    Input: None

    Output:

    <tag value="{text}" id="{int}" href="{uri}" count="{int}">
        <type>{text|date|define}</type>
        <uri>{uri}</uri>
        <title>{text}</title>
        <pages count="{int}">
            <page id="{int}" href="{uri}">
                <uri.ui>{uri}</uri.ui>
                <title>{text}</title>
                <path>{text}</path>
                <namespace>{namespace}</namespace>
            </page>
        </pages>
    </tag>

    Implementation Notes

    Tagging is a means of categorizing pages.  There are currently three types of supported tags:

    • Date: Defines a date or date range for the page.
    • Define: Indicates that this is a defining tag.  All other pages with a text tag having the same name will be marked as related to the page.
    • Text: Standard tag type.

    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