| POST | /api/comment |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Add a comment to the specified object.
*/
@Api(Description="Add a comment to the specified object.")
public static class AddComment
{
/**
* Object linked to the comment.
*/
@ApiMember(DataType="Guid", Description="Object linked to the comment.", IsRequired=true, Name="ConnectedObjectId")
public UUID ConnectedObjectId = null;
/**
* Comment content
*/
@ApiMember(DataType="string", Description="Comment content", IsRequired=true, Name="Comment")
public String Comment = null;
/**
* The comment suite id
*/
@ApiMember(DataType="Guid", Description="The comment suite id", Name="SuiteId")
public UUID SuiteId = null;
public UUID getConnectedObjectId() { return ConnectedObjectId; }
public AddComment setConnectedObjectId(UUID value) { this.ConnectedObjectId = value; return this; }
public String getComment() { return Comment; }
public AddComment setComment(String value) { this.Comment = value; return this; }
public UUID getSuiteId() { return SuiteId; }
public AddComment setSuiteId(UUID value) { this.SuiteId = value; return this; }
}
@ApiResponse(Description="Returns the communication id and response status.")
public static class SendCommunicationResponse
{
public UUID CommunicationId = null;
public ResponseStatus ResponseStatus = null;
public UUID getCommunicationId() { return CommunicationId; }
public SendCommunicationResponse setCommunicationId(UUID value) { this.CommunicationId = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public SendCommunicationResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/comment HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ConnectedObjectId":"00000000-0000-0000-0000-000000000000","Comment":"String","SuiteId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"CommunicationId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}