Messages
List
Messages - GET
/projects/#{project_id}/messages.xml
Retrieve a list of messages for the current project.
Response:
<messages>
<message>
...
</message>
<message>
...
</message>;
</messages>
Get
Message - GET
/projects/#{project_id}/messages/#{ID}.xml
This fetches the Message. Parent messages also have the comments included, while individual comments only contain the comment attributes.
Response:
<message>
<attachments-count type="integer">0</attachments-count>
<body>#{unprocessed body}</body>
<body-html>#{processed HTML body}</body-html>
<comments-count type="integer">3</comments-count>
<created-at type="datetime">2006-07-25T21:52:31Z</created-at>
<id type="integer">8</id>
<parent-id type="integer"></parent-id>
<permalink>#{message-permalink}</permalink>
<project-id type="integer">2</project-id>
<title>#{message title}</title>
<updated-at type="datetime">2007-01-15T21:22:05Z</updated-at>
<user-id type="integer">1</user-id>
<comments>
<comment type="Message">
...
</comment>
<comment type="Message">
...
</comment>
</comments>
</message>
New
Message - GET
/projects/#{project_id}/messages/new.xml
This gives you the initial state for an empty message.
Response:
<message>
<attachments-count type="integer">0</attachments-count>
<body></body>
<body-html></body-html>
<comments-count type="integer">0</comments-count>
<created-at type="datetime"></created-at>
<parent-id type="integer"></parent-id>
<permalink></permalink>
<project-id type="integer"></project-id>
<title></title>
<updated-at type="datetime"></updated-at>
<user-id type="integer"></user-id>
</message>
Create
Message - POST
/projects/#{project_id}/messages.xml
Creates a message. The shown fields are the only ones you can set:
- body - the body of message.
- title - the title of the message
Request:
<message>
<title>...</title>
<body></body>
</message>
Response:
HTTP Status: 201 Created Location: http://activereload.lighthouseapp.com/projects/5/messages/5.xml
<message>
...
</message>
Create Comment - POST
/projects/#{project_id}/messages/5/comments.xml
Creates a comment. The shown fields are the only ones you can set:
- body - the body of message.
- title - the title of the message
Request:
<comment>
<body></body>
</comment>
Response:
HTTP Status: 201 Created Location: http://activereload.lighthouseapp.com/projects/5/messages/6.xml
<message>
...
</message>
Update Message - PUT
/projects/#{project_id}/messages/ID.xml
Updates a message. The shown fields are the only ones you can set:
- body - the body of changeset log message.
- title - the title of the message
Request:
<message>
<title>...</title>
<body></body>
</message>
Response:
<p class="info">
<span class="status">HTTP Status: 200 OK</span>
</p>
Delete Message - DELETE
/projects/#{project_id}/messages/#{ID}.xml
Response:
<p class="info">
<span class="status">HTTP Status: 200 OK</span>
</p>