Overview

public. Retrieve the properties associated with a page

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)
contentcutoff int? Only show property content shorter than this number of bytes. Default: 2048
names string? Comma separated list of names of properties to return. The entire value should be URI encoded including the commas. Default: all properties
redirects int? If zero, do not follow page redirects.
Return CodesEdit section
Name Value Description
Forbidden 403 READ access to the page is required to see page properties
NotFound 404 Requested page could not be found
Ok 200 The request completed successfully

 

Message Format

Response is a list of the standard property xml blocks as well as the language element.

<properties count="{int}" href="{uri}">
 <property name="{text}" href="{uri}" etag="{text}">
  <contents type="{text}" href="{uri}">{text}</contents>
  <date.modified>{date}</date.modified>
  <user.modified id="{int}" href="{uri}">
    <nick>{text}</nick>
    <username>{text}</username>
  </user.modified>
  <change-description>{text}</change-description>
 </property>
 <language>{language}</language> 
</properties>

Implementation Notes

  • This feature shows the page language. An empty language indicates culture invariant.
  • READ access to the page is required to see page properties

Code Samples

The following code example retrieves the home page language:

Plug p = Plug.New("http://deki-hayes/@api/deki");  
p.At("pages", "home", "properties").Get();

Sample response indicating that the home page language is German:

<properties href="http://deki-hayes/@api/deki/pages/29/properties">
  <language>de</language> 
</properties>

The following code authenticates and retrieves all properties belonging to the page.

Plug p = Plug.New("http://devwiki/@api/deki"); 
p.At("users", "authenticate")
 .WithCredentials("sysop", "password").Get(); 
XDoc props = p.At("pages", "=My%252fTest%252fPage", "properties")
 .Get().AsDocument()

Response:

<properties count="1" href="http://devwiki/@api/deki/pages/42/properties">
  <property name="myprop" href="http://devwiki/@api/deki/pages/42/properties/myprop/info" etag="4465.r2_ts2009-03-20T23:52:50Z">
    <contents type="text/plain" href="http://devwiki/@api/deki/pages/42/properties/myprop">new value for property</contents>
    <date.modified>2009-03-20T23:52:50Z</date.modified>
    <user.modified id="1" href="http://devwiki/@api/deki/users/1">
      <nick>Sysop</nick>
      <username>Sysop</username>
    </user.modified>
    <change-description>description of change</change-description>
  </property>
</properties>

 

Tag page
You must login to post a comment.