<?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};
/** @description Inserts a communication that is not already saved. */
// @Api(Description="Inserts a communication that is not already saved.")
class SaveCommunication implements ISubscription, JsonSerializable
{
public function __construct(
/** @description Guid representing the external systems datasource information. */
// @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
/** @var string */
public string $SuiteDataSourceInstanceId='',
/** @description The unique key that represents the communication on the external system. */
// @ApiMember(DataType="string", Description="The unique key that represents the communication on the external system.", Name="AlternateKey", ParameterType="query")
/** @var string|null */
public ?string $AlternateKey=null,
/** @description Guid of the communication object within Eros. If ObjectId is known, the external system may pass this insted of the alternate key. */
// @ApiMember(DataType="Guid", Description="Guid of the communication object within Eros. If ObjectId is known, the external system may pass this insted of the alternate key.", IsRequired=true, Name="ObjectId", ParameterType="query")
/** @var string */
public string $ObjectId='',
/** @var bool|null */
public ?bool $IgnoreValidation=null,
/** @description Communication Status Id. */
// @ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")
/** @var string */
public string $CommunicationStatusId='',
/** @description XML containing the content of the communication. */
// @ApiMember(DataType="string", Description="XML containing the content of the communication.", IsRequired=true, Name="CommunicationXml", ParameterType="query")
/** @var string */
public string $CommunicationXml='',
/** @description Guid of the object this communication is related to. */
// @ApiMember(DataType="Guid", Description="Guid of the object this communication is related to.", IsRequired=true, Name="ObjectIdPrepositional", ParameterType="query")
/** @var string */
public string $ObjectIdPrepositional=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['SuiteDataSourceInstanceId'])) $this->SuiteDataSourceInstanceId = $o['SuiteDataSourceInstanceId'];
if (isset($o['AlternateKey'])) $this->AlternateKey = $o['AlternateKey'];
if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
if (isset($o['IgnoreValidation'])) $this->IgnoreValidation = $o['IgnoreValidation'];
if (isset($o['CommunicationStatusId'])) $this->CommunicationStatusId = $o['CommunicationStatusId'];
if (isset($o['CommunicationXml'])) $this->CommunicationXml = $o['CommunicationXml'];
if (isset($o['ObjectIdPrepositional'])) $this->ObjectIdPrepositional = $o['ObjectIdPrepositional'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->SuiteDataSourceInstanceId)) $o['SuiteDataSourceInstanceId'] = $this->SuiteDataSourceInstanceId;
if (isset($this->AlternateKey)) $o['AlternateKey'] = $this->AlternateKey;
if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
if (isset($this->IgnoreValidation)) $o['IgnoreValidation'] = $this->IgnoreValidation;
if (isset($this->CommunicationStatusId)) $o['CommunicationStatusId'] = $this->CommunicationStatusId;
if (isset($this->CommunicationXml)) $o['CommunicationXml'] = $this->CommunicationXml;
if (isset($this->ObjectIdPrepositional)) $o['ObjectIdPrepositional'] = $this->ObjectIdPrepositional;
return empty($o) ? new class(){} : $o;
}
}
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 /jsv/reply/SaveCommunication HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AlternateKey: String,
IgnoreValidation: False,
CommunicationXml: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}