Platform API

AddComment

Add a comment to the specified object.

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

import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Returns the communication id and response status.")
class SendCommunicationResponse implements IConvertible
{
    String? CommunicationId;
    ResponseStatus? ResponseStatus;

    SendCommunicationResponse({this.CommunicationId,this.ResponseStatus});
    SendCommunicationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CommunicationId = json['CommunicationId'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CommunicationId': CommunicationId,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SendCommunicationResponse";
    TypeContext? context = _ctx;
}

/**
* Add a comment to the specified object.
*/
// @Api(Description="Add a comment to the specified object.")
class AddComment implements IConvertible
{
    /**
    * Object linked to the comment.
    */
    // @ApiMember(DataType="Guid", Description="Object linked to the comment.", IsRequired=true, Name="ConnectedObjectId")
    String? ConnectedObjectId;

    /**
    * Comment content
    */
    // @ApiMember(DataType="string", Description="Comment content", IsRequired=true, Name="Comment")
    String? Comment;

    /**
    * The comment suite id
    */
    // @ApiMember(DataType="Guid", Description="The comment suite id", Name="SuiteId")
    String? SuiteId;

    AddComment({this.ConnectedObjectId,this.Comment,this.SuiteId});
    AddComment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ConnectedObjectId = json['ConnectedObjectId'];
        Comment = json['Comment'];
        SuiteId = json['SuiteId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ConnectedObjectId': ConnectedObjectId,
        'Comment': Comment,
        'SuiteId': SuiteId
    };

    getTypeName() => "AddComment";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SendCommunicationResponse': TypeInfo(TypeOf.Class, create:() => SendCommunicationResponse()),
    'AddComment': TypeInfo(TypeOf.Class, create:() => AddComment()),
});

Dart AddComment DTOs

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

HTTP + CSV

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

{"ConnectedObjectId":"00000000-0000-0000-0000-000000000000","Comment":"String","SuiteId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}