<?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 RuleValidationResult implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $RuleCode=null,
/** @var string|null */
public ?string $Message=null,
/** @var string|null */
public ?string $Key=null,
/** @var string|null */
public ?string $Tag=null,
/** @var string|null */
public ?string $ErrorCode=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RuleCode'])) $this->RuleCode = $o['RuleCode'];
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['Key'])) $this->Key = $o['Key'];
if (isset($o['Tag'])) $this->Tag = $o['Tag'];
if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RuleCode)) $o['RuleCode'] = $this->RuleCode;
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->Key)) $o['Key'] = $this->Key;
if (isset($this->Tag)) $o['Tag'] = $this->Tag;
if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
return empty($o) ? new class(){} : $o;
}
}
class ValidationErrorList implements JsonSerializable
{
public function __construct(
/** @var array<RuleValidationResult>|null */
public ?array $ValidationErrors=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ValidationErrors'])) $this->ValidationErrors = JsonConverters::fromArray('RuleValidationResult', $o['ValidationErrors']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ValidationErrors)) $o['ValidationErrors'] = JsonConverters::toArray('RuleValidationResult', $this->ValidationErrors);
return empty($o) ? new class(){} : $o;
}
}
class SubscriptionContactRoleModel implements JsonSerializable
{
public function __construct(
/** @description Name of the role. */
// @ApiMember(DataType="string", Description="Name of the role.", Name="RoleName", ParameterType="query")
/** @var string|null */
public ?string $RoleName=null,
/** @description Short version of the role name. */
// @ApiMember(DataType="string", Description="Short version of the role name.", Name="RoleShortName", ParameterType="query")
/** @var string|null */
public ?string $RoleShortName=null,
/** @description Description of the role purpose. */
// @ApiMember(DataType="string", Description="Description of the role purpose.", Name="RoleDescription", ParameterType="query")
/** @var string|null */
public ?string $RoleDescription=null,
/** @description If true, the role will be pending for a contact until they accept it. */
// @ApiMember(DataType="bool", Description="If true, the role will be pending for a contact until they accept it.", Name="RequireContactsToAccept", ParameterType="query")
/** @var bool|null */
public ?bool $RequireContactsToAccept=null,
/** @description Contact Types that may have this role. */
// @ApiMember(DataType="List<Guid>", Description="Contact Types that may have this role.", Name="ContactTypes", ParameterType="query")
/** @var array<string>|null */
public ?array $ContactTypes=null,
/** @description Role Filters this role should be added to. */
// @ApiMember(DataType="List<Guid>", Description="Role Filters this role should be added to.", Name="ListItemFilters", ParameterType="query")
/** @var array<string>|null */
public ?array $ListItemFilters=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RoleName'])) $this->RoleName = $o['RoleName'];
if (isset($o['RoleShortName'])) $this->RoleShortName = $o['RoleShortName'];
if (isset($o['RoleDescription'])) $this->RoleDescription = $o['RoleDescription'];
if (isset($o['RequireContactsToAccept'])) $this->RequireContactsToAccept = $o['RequireContactsToAccept'];
if (isset($o['ContactTypes'])) $this->ContactTypes = JsonConverters::fromArray('Guid', $o['ContactTypes']);
if (isset($o['ListItemFilters'])) $this->ListItemFilters = JsonConverters::fromArray('Guid', $o['ListItemFilters']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RoleName)) $o['RoleName'] = $this->RoleName;
if (isset($this->RoleShortName)) $o['RoleShortName'] = $this->RoleShortName;
if (isset($this->RoleDescription)) $o['RoleDescription'] = $this->RoleDescription;
if (isset($this->RequireContactsToAccept)) $o['RequireContactsToAccept'] = $this->RequireContactsToAccept;
if (isset($this->ContactTypes)) $o['ContactTypes'] = JsonConverters::toArray('Guid', $this->ContactTypes);
if (isset($this->ListItemFilters)) $o['ListItemFilters'] = JsonConverters::toArray('Guid', $this->ListItemFilters);
return empty($o) ? new class(){} : $o;
}
}
class SaveContactRole extends ValidationErrorList implements ISubscription, JsonSerializable
{
/**
* @param array<RuleValidationResult>|null $ValidationErrors
*/
public function __construct(
?array $ValidationErrors=null,
/** @description Guid representing the external systems data source information. */
// @ApiMember(DataType="Guid", Description="Guid representing the external systems data source information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
/** @var string */
public string $SuiteDataSourceInstanceId='',
/** @description The unique key that represents the contact role on the external system. */
// @ApiMember(DataType="string", Description="The unique key that represents the contact role on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
/** @var string */
public string $AlternateKey='',
/** @description Guid of the contact role object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key. */
// @ApiMember(DataType="Guid", Description="Guid of the contact role object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query")
/** @var string */
public string $ObjectId='',
/** @description Object containing all details of the contact role to be inserted or updated. */
// @ApiMember(DataType="SubscriptionContactRoleModel", Description="Object containing all details of the contact role to be inserted or updated.", IsRequired=true, Name="ContactRole", ParameterType="query")
/** @var SubscriptionContactRoleModel|null */
public ?SubscriptionContactRoleModel $ContactRole=null,
/** @var bool|null */
public ?bool $IgnoreValidation=null
) {
parent::__construct($ValidationErrors);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
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['ContactRole'])) $this->ContactRole = JsonConverters::from('SubscriptionContactRoleModel', $o['ContactRole']);
if (isset($o['IgnoreValidation'])) $this->IgnoreValidation = $o['IgnoreValidation'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
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->ContactRole)) $o['ContactRole'] = JsonConverters::to('SubscriptionContactRoleModel', $this->ContactRole);
if (isset($this->IgnoreValidation)) $o['IgnoreValidation'] = $this->IgnoreValidation;
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/SaveContactRole HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AlternateKey: String,
ContactRole:
{
RoleName: String,
RoleShortName: String,
RoleDescription: String,
RequireContactsToAccept: False,
ContactTypes:
[
00000000-0000-0000-0000-000000000000
],
ListItemFilters:
[
00000000-0000-0000-0000-000000000000
]
},
IgnoreValidation: False,
ValidationErrors:
[
{
RuleCode: String,
Message: String,
Key: String,
Tag: String,
ErrorCode: 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
}
}