| All Verbs | /api/objectcommunicationsubscriptions/{ObjectId} |
|---|
<?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 ObjectCommunicationSubscriptionDetailModel implements JsonSerializable
{
public function __construct(
/** @description */
// @ApiMember(Description="", Name="SubscriptionId")
/** @var string */
public string $SubscriptionId='',
/** @description */
// @ApiMember(Description="", Name="SubscriptionName")
/** @var string|null */
public ?string $SubscriptionName=null,
/** @description */
// @ApiMember(Description="", Name="RecordStatus")
/** @var string|null */
public ?string $RecordStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['SubscriptionId'])) $this->SubscriptionId = $o['SubscriptionId'];
if (isset($o['SubscriptionName'])) $this->SubscriptionName = $o['SubscriptionName'];
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->SubscriptionId)) $o['SubscriptionId'] = $this->SubscriptionId;
if (isset($this->SubscriptionName)) $o['SubscriptionName'] = $this->SubscriptionName;
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="List of object communication subscriptions")
class GetCommunicationSubscriptionsResponse implements JsonSerializable
{
public function __construct(
/** @var array<ObjectCommunicationSubscriptionDetailModel>|null */
public ?array $CommunicationSubscriptions=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CommunicationSubscriptions'])) $this->CommunicationSubscriptions = JsonConverters::fromArray('ObjectCommunicationSubscriptionDetailModel', $o['CommunicationSubscriptions']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CommunicationSubscriptions)) $o['CommunicationSubscriptions'] = JsonConverters::toArray('ObjectCommunicationSubscriptionDetailModel', $this->CommunicationSubscriptions);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Get object communication subscriptions for the specified object */
// @Api(Description="Get object communication subscriptions for the specified object")
class GetCommunicationSubscriptions implements JsonSerializable
{
public function __construct(
/** @description Get object communication subscriptions for the specified object */
// @ApiMember(Description="Get object communication subscriptions for the specified object", IsRequired=true, Name="ObjectId")
/** @var string */
public string $ObjectId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
return empty($o) ? new class(){} : $o;
}
}
PHP GetCommunicationSubscriptions DTOs
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 /api/objectcommunicationsubscriptions/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CommunicationSubscriptions:
[
{
SubscriptionName: String,
RecordStatus: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}