| 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}