Platform API

AddComment

Add a comment to the specified object.

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Add a comment to the specified object.
        '''</Summary>
        <Api(Description:="Add a comment to the specified object.")>
        Public Partial Class AddComment
            '''<Summary>
            '''Object linked to the comment.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Object linked to the comment.", IsRequired:=true, Name:="ConnectedObjectId")>
            Public Overridable Property ConnectedObjectId As Guid

            '''<Summary>
            '''Comment content
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Comment content", IsRequired:=true, Name:="Comment")>
            Public Overridable Property Comment As String

            '''<Summary>
            '''The comment suite id
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="The comment suite id", Name:="SuiteId")>
            Public Overridable Property SuiteId As Guid
        End Class

        <ApiResponse(Description:="Returns the communication id and response status.")>
        Public Partial Class SendCommunicationResponse
            Public Overridable Property CommunicationId As Guid
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET AddComment DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	Comment: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}