| POST | /api/comment |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Add a comment to the specified object.
*/
@Api(Description="Add a comment to the specified object.")
open class AddComment
{
/**
* Object linked to the comment.
*/
@ApiMember(DataType="Guid", Description="Object linked to the comment.", IsRequired=true, Name="ConnectedObjectId")
open var ConnectedObjectId:UUID? = null
/**
* Comment content
*/
@ApiMember(DataType="string", Description="Comment content", IsRequired=true, Name="Comment")
open var Comment:String? = null
/**
* The comment suite id
*/
@ApiMember(DataType="Guid", Description="The comment suite id", Name="SuiteId")
open var SuiteId:UUID? = null
}
@ApiResponse(Description="Returns the communication id and response status.")
open class SendCommunicationResponse
{
open var CommunicationId:UUID? = null
open var ResponseStatus:ResponseStatus? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
Content-Length: length
{"ConnectedObjectId":"00000000-0000-0000-0000-000000000000","Comment":"String","SuiteId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}