| POST | /api/comment |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
// @ApiResponse(Description="Returns the communication id and response status.")
class SendCommunicationResponse implements JsonSerializable
{
public function __construct(
/** @var string */
public string $CommunicationId='',
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CommunicationId'])) $this->CommunicationId = $o['CommunicationId'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CommunicationId)) $o['CommunicationId'] = $this->CommunicationId;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Add a comment to the specified object. */
// @Api(Description="Add a comment to the specified object.")
class AddComment implements JsonSerializable
{
public function __construct(
/** @description Object linked to the comment. */
// @ApiMember(DataType="Guid", Description="Object linked to the comment.", IsRequired=true, Name="ConnectedObjectId")
/** @var string */
public string $ConnectedObjectId='',
/** @description Comment content */
// @ApiMember(DataType="string", Description="Comment content", IsRequired=true, Name="Comment")
/** @var string */
public string $Comment='',
/** @description The comment suite id */
// @ApiMember(DataType="Guid", Description="The comment suite id", Name="SuiteId")
/** @var string */
public string $SuiteId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ConnectedObjectId'])) $this->ConnectedObjectId = $o['ConnectedObjectId'];
if (isset($o['Comment'])) $this->Comment = $o['Comment'];
if (isset($o['SuiteId'])) $this->SuiteId = $o['SuiteId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ConnectedObjectId)) $o['ConnectedObjectId'] = $this->ConnectedObjectId;
if (isset($this->Comment)) $o['Comment'] = $this->Comment;
if (isset($this->SuiteId)) $o['SuiteId'] = $this->SuiteId;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}