Platform API

<back to all web services

AddComment

Add a comment to the specified object.

Requires Authentication
The following routes are available for this service:
POST/api/comment
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="Returns the communication id and response status.")>]
    [<AllowNullLiteral>]
    type SendCommunicationResponse() = 
        member val CommunicationId:Guid = new Guid() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Add a comment to the specified object.
    ///</summary>
    [<Api(Description="Add a comment to the specified object.")>]
    [<AllowNullLiteral>]
    type AddComment() = 
        ///<summary>
        ///Object linked to the comment.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Object linked to the comment.", IsRequired=true, Name="ConnectedObjectId")>]
        member val ConnectedObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///Comment content
        ///</summary>
        [<ApiMember(DataType="string", Description="Comment content", IsRequired=true, Name="Comment")>]
        member val Comment:String = null with get,set

        ///<summary>
        ///The comment suite id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The comment suite id", Name="SuiteId")>]
        member val SuiteId:Guid = new Guid() with get,set

F# AddComment DTOs

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

HTTP + JSON

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"}}}