Send feedback about one of a map's topics - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

This web service makes it possible to send feedback about one of a map's topics.

This web service requires the caller to be authenticated and have the FEEDBACK_USER role.

Method Endpoint
POST /api/khub/maps/{mapId}/topics/{tocId}/feedback
Path parameter Type Description
{mapId} String Expects the id associated with the map. Can be obtained by listing maps.
{tocId} String Expects the id associated with the topic as retrieved when getting a map's table of contents.

Request example

The following lines show an example of a JSON request body:

{
    "message": "This is my feedback message",
    "from": "jdoe@example.com"
}
Field Type Required? Description
message String Yes A message containing the caller's feedback.
from String Yes The email address of the feedback's sender. It is only necessary when the Email service for unauthenticated users setting is set to Feedback sent by Fluid Topics email sending method.
Return code Description
200 OK The feedback was submitted.
401 UNAUTHORIZED The authorization header is absent or invalid.
403 FORBIDDEN The user or API key does not have the FEEDBACK_USER role.
404 NOT FOUND No map exists with this identifier.

Tip

For a comprehensive list of all possible return codes, see Return codes.