| All Verbs | /api/objectsubscriptions/{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 ObjectSubscriptionDetailModel implements JsonSerializable
{
public function __construct(
/** @description ID for the objectSubscription record. */
// @ApiMember(Description="ID for the objectSubscription record.", Name="ObjectSubscriptionId")
/** @var string */
public string $ObjectSubscriptionId='',
/** @description Id of the Suite DataSource Instance Id. */
// @ApiMember(Description="Id of the Suite DataSource Instance Id.", Name="SuiteDataSourceInstanceId")
/** @var string */
public string $SuiteDataSourceInstanceId='',
/** @description Suite DataSource Instance Name. */
// @ApiMember(Description="Suite DataSource Instance Name.", Name="SuiteDataSourceName")
/** @var string|null */
public ?string $SuiteDataSourceName=null,
/** @description Id indicating the RmsTableCtx of the object. */
// @ApiMember(Description="Id indicating the RmsTableCtx of the object.", Name="RmsTableContextId")
/** @var string */
public string $RmsTableContextId='',
/** @description Id of the integrated object. */
// @ApiMember(Description="Id of the integrated object.", Name="ObjectId")
/** @var string */
public string $ObjectId='',
/** @description Unique Key of this object in the external Data Source. */
// @ApiMember(Description="Unique Key of this object in the external Data Source.", Name="AlternateKey")
/** @var string|null */
public ?string $AlternateKey=null,
/** @description Date the object was integrated. */
// @ApiMember(Description="Date the object was integrated.", Name="CreatedAt")
/** @var DateTime */
public DateTime $CreatedAt=new DateTime(),
/** @description Record Status of the object subscription. */
// @ApiMember(Description="Record Status of the object subscription.", Name="RecordStatus")
/** @var string|null */
public ?string $RecordStatus=null,
/** @description Id of the Suite Instance. */
// @ApiMember(Description="Id of the Suite Instance.", Name="SuiteInstanceId")
/** @var string */
public string $SuiteInstanceId='',
/** @description Suite Instance Name. */
// @ApiMember(Description="Suite Instance Name.", Name="SuiteInstanceName")
/** @var string|null */
public ?string $SuiteInstanceName=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ObjectSubscriptionId'])) $this->ObjectSubscriptionId = $o['ObjectSubscriptionId'];
if (isset($o['SuiteDataSourceInstanceId'])) $this->SuiteDataSourceInstanceId = $o['SuiteDataSourceInstanceId'];
if (isset($o['SuiteDataSourceName'])) $this->SuiteDataSourceName = $o['SuiteDataSourceName'];
if (isset($o['RmsTableContextId'])) $this->RmsTableContextId = $o['RmsTableContextId'];
if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
if (isset($o['AlternateKey'])) $this->AlternateKey = $o['AlternateKey'];
if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
if (isset($o['SuiteInstanceId'])) $this->SuiteInstanceId = $o['SuiteInstanceId'];
if (isset($o['SuiteInstanceName'])) $this->SuiteInstanceName = $o['SuiteInstanceName'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ObjectSubscriptionId)) $o['ObjectSubscriptionId'] = $this->ObjectSubscriptionId;
if (isset($this->SuiteDataSourceInstanceId)) $o['SuiteDataSourceInstanceId'] = $this->SuiteDataSourceInstanceId;
if (isset($this->SuiteDataSourceName)) $o['SuiteDataSourceName'] = $this->SuiteDataSourceName;
if (isset($this->RmsTableContextId)) $o['RmsTableContextId'] = $this->RmsTableContextId;
if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
if (isset($this->AlternateKey)) $o['AlternateKey'] = $this->AlternateKey;
if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
if (isset($this->SuiteInstanceId)) $o['SuiteInstanceId'] = $this->SuiteInstanceId;
if (isset($this->SuiteInstanceName)) $o['SuiteInstanceName'] = $this->SuiteInstanceName;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="List of object subscriptions")
class GetObjectSubscriptionsResponse implements JsonSerializable
{
public function __construct(
/** @var array<ObjectSubscriptionDetailModel>|null */
public ?array $ObjectSubscriptions=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ObjectSubscriptions'])) $this->ObjectSubscriptions = JsonConverters::fromArray('ObjectSubscriptionDetailModel', $o['ObjectSubscriptions']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ObjectSubscriptions)) $o['ObjectSubscriptions'] = JsonConverters::toArray('ObjectSubscriptionDetailModel', $this->ObjectSubscriptions);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Get object subscriptions for the specified object */
// @Api(Description="Get object subscriptions for the specified object")
class GetObjectSubscriptions implements JsonSerializable
{
public function __construct(
/** @description Get active/inactive object subscriptions for the specified object */
// @ApiMember(Description="Get active/inactive object 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 GetObjectSubscriptions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/objectsubscriptions/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ObjectSubscriptions":[{"ObjectSubscriptionId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceInstanceId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceName":"String","RmsTableContextId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","AlternateKey":"String","CreatedAt":"0001-01-01T00:00:00.0000000","RecordStatus":"String","SuiteInstanceId":"00000000-0000-0000-0000-000000000000","SuiteInstanceName":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}