Platform API

AddComment

Add a comment to the specified object.

The following routes are available for this service:
POST	/api/comment

import Foundation
import ServiceStack

/**
* Add a comment to the specified object.
*/
// @Api(Description="Add a comment to the specified object.")
public class AddComment : Codable
{
    /**
    * Object linked to the comment.
    */
    // @ApiMember(DataType="Guid", Description="Object linked to the comment.", IsRequired=true, Name="ConnectedObjectId")
    public var connectedObjectId:String

    /**
    * Comment content
    */
    // @ApiMember(DataType="string", Description="Comment content", IsRequired=true, Name="Comment")
    public var comment:String

    /**
    * The comment suite id
    */
    // @ApiMember(DataType="Guid", Description="The comment suite id", Name="SuiteId")
    public var suiteId:String

    required public init(){}
}

// @ApiResponse(Description="Returns the communication id and response status.")
public class SendCommunicationResponse : Codable
{
    public var communicationId:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift AddComment DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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"}}}