Page last modified 21:07, 26 Jul 2010 by arnec
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch API > GET:site/properties
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
- 4.1. C# Samples
- 4.2. Curl Samples
- 4.3. PHP Samples
- 4.4. Other Code Samples
Overview
public. Retrieve the properties associated with the site
Uri Parameters
None
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. Use '*' at the start or end of a name for wildcard matches. Default: all properties |
| redirects | int? | If zero, do not follow page redirects. |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter |
| Forbidden | 403 | ADMIN access is required |
| 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.
- ADMIN access is required to see site properties
Code Samples
C# Samples
Curl Samples
PHP Samples
Other Code Samples
- Was this page helpful?
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by