| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/ConversationDetail |
|---|
<?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};
class ConversationDetail implements JsonSerializable
{
public function __construct(
/** @var string */
public string $ConversationDetailId='',
/** @var string */
public string $ConversationHeaderId='',
/** @var string|null */
public ?string $Comment=null,
/** @var DateTime */
public DateTime $DateCreated=new DateTime(),
/** @var string */
public string $CreatedBy='',
/** @var string|null */
public ?string $CreatedByName=null,
/** @var string */
public string $AttachmentId='',
/** @var bool|null */
public ?bool $IsAdminComment=null,
/** @var bool|null */
public ?bool $IsDeletedComment=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ConversationDetailId'])) $this->ConversationDetailId = $o['ConversationDetailId'];
if (isset($o['ConversationHeaderId'])) $this->ConversationHeaderId = $o['ConversationHeaderId'];
if (isset($o['Comment'])) $this->Comment = $o['Comment'];
if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
if (isset($o['CreatedByName'])) $this->CreatedByName = $o['CreatedByName'];
if (isset($o['AttachmentId'])) $this->AttachmentId = $o['AttachmentId'];
if (isset($o['IsAdminComment'])) $this->IsAdminComment = $o['IsAdminComment'];
if (isset($o['IsDeletedComment'])) $this->IsDeletedComment = $o['IsDeletedComment'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ConversationDetailId)) $o['ConversationDetailId'] = $this->ConversationDetailId;
if (isset($this->ConversationHeaderId)) $o['ConversationHeaderId'] = $this->ConversationHeaderId;
if (isset($this->Comment)) $o['Comment'] = $this->Comment;
if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
if (isset($this->CreatedByName)) $o['CreatedByName'] = $this->CreatedByName;
if (isset($this->AttachmentId)) $o['AttachmentId'] = $this->AttachmentId;
if (isset($this->IsAdminComment)) $o['IsAdminComment'] = $this->IsAdminComment;
if (isset($this->IsDeletedComment)) $o['IsDeletedComment'] = $this->IsDeletedComment;
return empty($o) ? new class(){} : $o;
}
}
class ConversationDetailResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var ConversationDetail|null */
public ?ConversationDetail $ConversationDetail=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['ConversationDetail'])) $this->ConversationDetail = JsonConverters::from('ConversationDetail', $o['ConversationDetail']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->ConversationDetail)) $o['ConversationDetail'] = JsonConverters::to('ConversationDetail', $this->ConversationDetail);
return empty($o) ? new class(){} : $o;
}
}
class ConversationDetailRequest implements JsonSerializable
{
public function __construct(
/** @var ConversationDetail|null */
public ?ConversationDetail $ConversationDetail=null,
/** @var string */
public string $ConversationHeaderId='',
/** @var string|null */
public ?string $AttachmentComment=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ConversationDetail'])) $this->ConversationDetail = JsonConverters::from('ConversationDetail', $o['ConversationDetail']);
if (isset($o['ConversationHeaderId'])) $this->ConversationHeaderId = $o['ConversationHeaderId'];
if (isset($o['AttachmentComment'])) $this->AttachmentComment = $o['AttachmentComment'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ConversationDetail)) $o['ConversationDetail'] = JsonConverters::to('ConversationDetail', $this->ConversationDetail);
if (isset($this->ConversationHeaderId)) $o['ConversationHeaderId'] = $this->ConversationHeaderId;
if (isset($this->AttachmentComment)) $o['AttachmentComment'] = $this->AttachmentComment;
return empty($o) ? new class(){} : $o;
}
}
PHP ConversationDetailRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/ConversationDetail HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ConversationDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AttachmentComment>String</AttachmentComment>
<ConversationDetail>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<Comment>String</Comment>
<ConversationDetailId>00000000-0000-0000-0000-000000000000</ConversationDetailId>
<ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
<CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
<CreatedByName>String</CreatedByName>
<DateCreated xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</DateCreated>
<IsAdminComment>false</IsAdminComment>
<IsDeletedComment>false</IsDeletedComment>
</ConversationDetail>
<ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
</ConversationDetailRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ConversationDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ConversationDetail>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<Comment>String</Comment>
<ConversationDetailId>00000000-0000-0000-0000-000000000000</ConversationDetailId>
<ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
<CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
<CreatedByName>String</CreatedByName>
<DateCreated xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</DateCreated>
<IsAdminComment>false</IsAdminComment>
<IsDeletedComment>false</IsDeletedComment>
</ConversationDetail>
<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>
</ConversationDetailResponse>