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