| All Verbs | /api/customcontentviews |
|---|
<?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 CustomContentViewModel implements JsonSerializable
{
public function __construct(
/** @description Id of the Custom Content View. */
// @ApiMember(DataType="Guid", Description="Id of the Custom Content View.", Name="ContentViewId", ParameterType="query")
/** @var string */
public string $ContentViewId='',
/** @description Name of the Custom Content View. */
// @ApiMember(DataType="string", Description="Name of the Custom Content View.", Name="Name", ParameterType="query")
/** @var string|null */
public ?string $Name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ContentViewId'])) $this->ContentViewId = $o['ContentViewId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ContentViewId)) $o['ContentViewId'] = $this->ContentViewId;
if (isset($this->Name)) $o['Name'] = $this->Name;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="Returns the Views matching the specified type.")
class GetCustomContentViewsResponse implements JsonSerializable
{
public function __construct(
/** @var array<CustomContentViewModel>|null */
public ?array $Views=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Views'])) $this->Views = JsonConverters::fromArray('CustomContentViewModel', $o['Views']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Views)) $o['Views'] = JsonConverters::toArray('CustomContentViewModel', $this->Views);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Request a list of Custom Content Views for the current licensee of the specified type. */
// @Api(Description="Request a list of Custom Content Views for the current licensee of the specified type.")
class GetCustomContentViews implements JsonSerializable
{
public function __construct(
/** @description The RmsTableCtxId representing the type of views we are retrieving. */
// @ApiMember(DataType="Guid", Description="The RmsTableCtxId representing the type of views we are retrieving.", IsRequired=true, Name="RmsTableCtxId", ParameterType="query")
/** @var string */
public string $RmsTableCtxId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RmsTableCtxId'])) $this->RmsTableCtxId = $o['RmsTableCtxId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RmsTableCtxId)) $o['RmsTableCtxId'] = $this->RmsTableCtxId;
return empty($o) ? new class(){} : $o;
}
}
PHP GetCustomContentViews 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/customcontentviews 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
{
Views:
[
{
Name: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}