Platform API

AddComment

Add a comment to the specified object.

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

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

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 virtual Guid ConnectedObjectId { get; set; }

        ///<summary>
        ///Comment content
        ///</summary>
        [ApiMember(DataType="string", Description="Comment content", IsRequired=true, Name="Comment")]
        public virtual string Comment { get; set; }

        ///<summary>
        ///The comment suite id
        ///</summary>
        [ApiMember(DataType="Guid", Description="The comment suite id", Name="SuiteId")]
        public virtual Guid SuiteId { get; set; }
    }

    [ApiResponse(Description="Returns the communication id and response status.")]
    public partial class SendCommunicationResponse
    {
        public virtual Guid CommunicationId { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# AddComment DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<AddComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Comment>String</Comment>
  <ConnectedObjectId>00000000-0000-0000-0000-000000000000</ConnectedObjectId>
  <SuiteId>00000000-0000-0000-0000-000000000000</SuiteId>
</AddComment>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendCommunicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <CommunicationId>00000000-0000-0000-0000-000000000000</CommunicationId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SendCommunicationResponse>