This service displays comments about a resource of the calling website, and allows the user to add a comment. A resource can be anything: a web page, a sold item, etc.
This service uses language negotiation in order to display web pages in a language preferred by the user's browser. Currently supported are english, german and french. If the browser does not accept any of these languages, then english is used by default.
Parameter
As parameter, this service expects an XML document that looks like this:
<!--
In this example, the commented resource is a web page,
and the end-user is logged in to the calling website
as john.smith@mail.com.
-->
<parameters> <!-- required -->
<resource> <!-- required -->
<id>/comments/test_resource</id> <!-- required -->
<title>Resource commenting example</title> <!-- optional -->
</resource>
<user> <!-- optional -->
<id>john.smith@mail.com</id> <!-- required -->
<name>John Smith</name> <!-- optional -->
</user>
</parameters>
The resource identifier should be a string less than 255 characters long. Leading and trailing whitespace is ignored.
If the end-user is logged in to the calling website, then it is a good idea to include the user information in the parameter, in order to avoid him/her submitting comments anonymously.
Result
This service returns nil as result.
Call example
Here is a web page which uses this service for its comments. When the end-user clicks on the 'View comments' link, the browser receives a Qworum message which might look like this:
<qrm:goto href='/comments/test_resource' xmlns:qrm='http://www.qworum.com/'>
<qrm:call href='http://www.qworum.com/comments/view'>
<parameters>
<resource>
<id>/comments/test_resource</id>
<title>Resource commenting example</title>
</resource>
</parameters>
</qrm:call>
</qrm:goto>