Planzone Web Kit
Sign in
Most viewed pages
3496
3346
3286
Most recent pages
10/27/10
10/27/10
10/27/10
10/27/10
10/27/10
messages
Published 10/27/10 by Stephane Carrez
Description
This operation lists the messages.
URI
GET lists the messages
http://ws.planzone.com/v1/rest/messages
Formats
xml, jsonRequires Authentication (about authentication):
yesRequires Authorization (about authorization):
The application must have the 'read' permission granted from the Planzone.
API rate limited (about rate limiting):
trueParameters
| Name | Optional | Description |
|---|---|---|
| entity | YES | List the messages which are associated with the given entities. The parameter defines a list of GUID entities separated by a comma (,). |
Request Example
The following request:
GET /v1/rest/messages?entity=B23DC
lists the messages associated with the todo B23DC.
Response
The response contains a message XML element which describes the messages.
<messages>
<message id="ELC23" type="document" date='2010-02-27'>
<subject>Document title</subject>
<author id='D2233' status='active'>
<name>John Smith</name>
<email>js@gmail.com</email>
</author>
<text>...</text>
</message>
</messages>
The subject element is optional. It is reported for some project messages.
HTTP Status Codes
| 200 | OK | Operation succeeded |
See also
todos
messages/create
message XML element